https://github.com/acoshift/arpc
acoshift's opinionated HTTP-RPC styled api
https://github.com/acoshift/arpc
Last synced: 11 months ago
JSON representation
acoshift's opinionated HTTP-RPC styled api
- Host: GitHub
- URL: https://github.com/acoshift/arpc
- Owner: acoshift
- License: mit
- Created: 2019-04-19T05:32:10.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-22T00:38:24.000Z (about 3 years ago)
- Last Synced: 2024-06-21T17:13:52.335Z (almost 2 years ago)
- Language: Go
- Homepage:
- Size: 56.6 KB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# arpc
[](https://codecov.io/gh/acoshift/arpc)
[](https://goreportcard.com/report/github.com/acoshift/arpc)
[](https://pkg.go.dev/github.com/acoshift/arpc)
ARPC is the Acoshift's opinionated HTTP-RPC styled api
## Installation
```
go get -u github.com/acoshift/arpc/v2
```
## HTTP Status Code
ARPC will response http with only these 3 status codes
- 200 OK - function works as expected
- 400 Bad Request - developer (api caller) error, should never happened in production
- 500 Internal Server Error - server error, should never happened (server broken)
## Example Responses
### Success Result
```http
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ok": true,
"result": {
// result object
}
}
```
### Error Result
- Validate error
- Precondition failed
- User error
```http
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"ok": false,
"error": {
"message": "some error message"
}
}
```
### Function not found
- Developer (api caller) call not exists function
```http
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
"ok": false,
"error": {
"message": "not found"
}
}
```
### Unsupported Content-Type
- Developer (api caller) send invalid content type
```http
HTTP/1.1 400 Bad Request
Content-Type: application/json; charset=utf-8
{
"ok": false,
"error": {
"message": "unsupported content type"
}
}
```
### Internal Server Error
- Server broken !!!
```http
HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
{
"ok": false,
"error": {} // internal error always return empty object
}
```
## How to use
```go
package main
import (
"context"
"log"
"net/http"
"github.com/acoshift/arpc/v2"
)
func main() {
// create new manager
am := arpc.New()
mux := http.NewServeMux()
mux.Handle("/hello", am.Handle(Hello))
// start server
log.Fatal(http.ListenAndServe(":8080", mux))
}
type HelloParams struct {
Name string `json:"name"`
}
func (r *HelloParams) Valid() error {
if r.Name == "" {
return arpc.NewError("name required")
}
return nil
}
type HelloResult struct {
Message string `json:"message"`
}
func Hello(ctx context.Context, req *HelloParams) (*HelloResult, error) {
return &HelloResult{
Message: "hello " + req.Name,
}, nil
}
```
## License
MIT