Description
Exposes any command-line program as REST service. Supported features: * Cross-platform. Can run on every platform supported by Go language compiler * Lightweight. Just one executable file. All dependencies are statically linked * RAML compatible. You can describe REST API for any command-line program using RAML 1.0 markup language based on YAML. The same RAML file you can use to generate documentation for your REST API using ReadTheDocs or any other toolchain for documentation * Supports for file transfer through REST API that can be used as input argument for command-line program * Mapping between process exit statuses and HTTP statuses * Supported JSON types: number, string, boolean, array FastCGI support
go2rest alternatives and similar packages
Based on the "Utilities" category.
Alternatively, view go2rest alternatives based on common mentions on social networks and blogs.
-
项目文档
🚀Vite+Vue3+Gin的开发基础平台,支持TS和JS混用。它集成了JWT鉴权、权限管理、动态路由、显隐可控组件、分页封装、多点登录拦截、资源权限、上传下载、代码生成器、表单生成器和可配置的导入导出等开发必备功能。 -
excelize
Go language library for reading and writing Microsoft Excel™ (XLAM / XLSM / XLSX / XLTM / XLTX) spreadsheets -
Kopia
Cross-platform backup tool for Windows, macOS & Linux with fast, incremental backups, client-side end-to-end encryption, compression and data deduplication. CLI and GUI included. -
goreporter
A Golang tool that does static analysis, unit testing, code review and generate code quality report. -
create-go-app
✨ A complete and self-contained solution for developers of any qualification to create a production-ready project with backend (Go), frontend (JavaScript, TypeScript) and deploy automation (Ansible, Docker) by running only one CLI command. -
EaseProbe
A simple, standalone, and lightweight tool that can do health/status checking, written in Go. -
filetype
Fast, dependency-free Go package to infer binary file types based on the magic numbers header signature -
boilr
:zap: boilerplate template manager that generates files or directories from template repositories -
beaver
💨 A real time messaging system to build a scalable in-app notifications, multiplayer games, chat apps in web and mobile apps. -
go-underscore
Helpfully Functional Go - A useful collection of Go utilities. Designed for programmer happiness.
WorkOS - The modern identity platform for B2B SaaS
Do you think we are missing an alternative of go2rest or a related project?
Popular Comparisons
README
go2rest exposes any existing command-line program as REST service.
Features
- Cross-platform. Can run on every platform supported by Go language compiler
- Lightweight. Just one executable file. All dependencies are statically linked
- RAML compatible. You can describe REST API for any command-line program using RAML 1.0 markup language based on YAML. The same RAML file you can use to generate documentation for your REST API using ReadTheDocs or any other toolchain for documentation
- Supports for file transfer through REST API that can be used as input argument for command-line program
- Mapping between process exit statuses and HTTP statuses
- Supported JSON types: number, string, boolean, array
- FastCGI support
How to build
- Install Go compiler according to your Operating System
- Run
go get github.com/sakno/go2rest
- Run
go build github.com/sakno/go2rest
- Grab compiled executable from your current directory
How to use
- Describe REST API in the form of RAML file with
.raml
extension. Read Wiki for detailed guide of how to write correct RAML file; or look at RAML file used for tests. - Run
go2rest [--port <port>] <path/to/file.raml>
. Now REST service is hosted on specified port
If you want to run service in FastCGI mode then omit port number like this: go2rest <path/to/file.raml>
RAML file should have .raml
extension. go2rest uses file extension to determine correct model parser because, in future, the program may support
another model formats such as OpenAPI.
Room for improvements
Internal representation of REST model does not rely on RAML directly. It is possible to implement any descriptive model of API. For example, OpenAPI Spec used by Swagger toolchain.
JSON Object (dictionary) data type is not supported at this moment but can be implemented easily.
Some of RAML features are not supported:
- Multipart form data
- Includes, Libraries, Overlays, and Extensions