Unfortunately, I haven't been able to continue active support for this project, as I've been busy with other private commercial endeavours. Since this project is in use in several projects and has several active forks, I'm looking for someone to take over this and make it useful once again.
The basic features I'd suggest are:
- Support for RAML 1.0 spec
- Validate using jsonschema, full integration
- Implement an integration with https://github.com/astaxie/beego or https://github.com/labstack/echo to auto-generate server code
- Generate go client for API
- Additional features, taking inspiration from https://github.com/go-swagger/go-swagger
If you're interested in taking over this project, please let me know. Email me at diamant.alon@gmail.com.
Thanks!
--
--
An implementation of a RAML parser for Go. Compliant with RAML 0.8.
RAML is a YAML-based language that describes RESTful APIs. Together with the YAML specification, this specification provides all the information necessary to describe RESTful APIs; to create API client-code and API server-code generators; and to create API user documentation from RAML API definitions.
The raml package enables Go programs to parse RAML files and valid RAML API definitions. It was originally developed within EverythingMe.
The raml package is currently unstable and does not offer any kind of API stability guarantees.
The yaml package may be installed by running:
$ go get gopkg.in/raml.v0
Opening that same URL in a browser will present a nice introductory page containing links to the documentation, source code, and all versions available for the given package:
The actual implementation of the package is in GitHub:
https://github.com/go-raml/raml
Typical installation process for developing purposes:
$ git clone git@github.com:go-raml/raml.git
$ cd raml
$ go build
$ go install
$ go test
Usage is very simple:
package main
import (
"fmt"
raml "gopkg.in/raml.v0"
"github.com/kr/pretty"
)
func main() {
fileName := "./samples/congo/api.raml"
if apiDefinition, err := raml.ParseFile(fileName); err != nil {
fmt.Printf("Failed parsing RAML file %s:\n %s", fileName, err.Error())
} else {
fmt.Printf("Successfully parsed RAML file %s!\n\n", fileName)
pretty.Printf(apiDefinition)
}
}
- Look up the RAML 0.8 spec if in doubt
- Contact Alon, the maintainer, directly: diamant.alon@gmail.com
TBD.
- Want to report a bug or request a feature? Please open an issue.
- Want to contribute to raml? Fork the project and make a pull request. Cool cool cool.
See LICENSE file.