https://github.com/opentable/swaggering
Swagger 1.2 code generator
https://github.com/opentable/swaggering
Last synced: 3 months ago
JSON representation
Swagger 1.2 code generator
- Host: GitHub
- URL: https://github.com/opentable/swaggering
- Owner: opentable
- License: mit
- Created: 2016-03-30T07:45:58.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-05-14T00:37:23.000Z (about 6 years ago)
- Last Synced: 2025-01-28T23:09:51.446Z (4 months ago)
- Language: Go
- Size: 291 KB
- Stars: 0
- Watchers: 20
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
# Swaggering
Swagger 1.2 code generator
(For Swagger 2.0, please see https://github.com/go-swagger/go-swagger)
Swaggering is a library for generating code based on Swagger 1.2 JSON description files.
To *use* this library, you'll probably want to
```bash
go get github.com/opentable/swaggering/cmd/swagger-client-maker
```
# Note
My experience has been that Swagger JSON descriptions can be flaky.
Swaggering does its best to generate code anyway -
when there are references to models that don't exist in the API
Swaggering templates in struct fields but comments them out.
I've found the best thing is to amend the JSON rather than the resulting code.
For that, `jq` is an invaluable tool.
# Building
Note that the default templates live in defaultApi.tmpl and defaultModel.tmpl -
if you update those files, you need to run `go generate` to update templates.go.
# Future Work
Maybe it'd be best to do all this with gofmt stuff instead of templates.
c.f. https://github.com/sasha-s/go-inline for ideas.