Generated server code uses these libraries:
- gorilla mux as router
- go-validator for request body validation
Generated client library only use http package from stdlib.
RAML Object usually become Go struct.
Some rules about type's properties naming:
- capitalizing first character of the properties.
- json tag is the same as property name
Raml | Go
----------- | -----------
string | string
number | float64
integer | int
boolean | bool
date | goraml.Date
enum | see below for explanation
file | string
Array | Array
Union | interface{}
Enum is converted into:
- new type definition
- const variable for each enum value
Enum type and file name is started by Enum
Validation | Go
--------------------------- | ------
minLength | v
maxLength | v
pattern | v
minimum | v
maximum | v
format | x
multipleOf | v
array field minItems | v
array field maxItems | v
array field uniqueItems | v
array Type minItems | v
array Type maxItems | v
array Type uniqueItems | v
Request and response body are mapped into structs and following the same rules as types.
struct name = [Resource name][Method name][ReqBody|RespBody].
Resources in the server are mapped to:
-
interface:
- file name = [resource]_if.go
- always be regenerated
- interface name = [resource]Interface
-
API implementation that implements the interface
- file name = [resource]_api.go
- only generated when the file is not present
- struct name = [resource]API
-
routes for all necessary routes:
- func name = [Resource]InterfaceRoutes
Resourcess in the client are implemented as services.
Let's say we have two root resources:
- /users
- /network
Client library is going to have two services:
- Users
- Network
Each service will have it's own methods
Code related to Requests Headers are only generated in the Client lib. All functions have arguments to send any request header, the current client lib will not check the headers against the RAML specifications.
Response headers related code are only generated in the server in the form of commented code, example:
// uncomment below line to add header
// w.Header.Set("key","value")
All client library functions have arguments to send query strings and query Parameters.
The generated code in the server is in the form of commented code:
// name := req.FormValue("name")
Resource Types and Traits already parsed by the parser. So, the generator need to know nothing about it.
go-raml only supports OAuth2.0.
- client : it currently able to get oauth2 token with client credentials.
- server : it currently only support JWT token from itsyou.online
Includes should work properly
Libraries should work properly, a library will be generated into a package.