forked from go-swagger/go-swagger
-
Notifications
You must be signed in to change notification settings - Fork 1
/
doc.go
50 lines (31 loc) · 2.09 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/*Package swagger (2.0) provides a powerful interface to your API
Contains an implementation of Swagger 2.0.
It knows how to serialize, deserialize and validate swagger specifications.
Swagger is a simple yet powerful representation of your RESTful API.
With the largest ecosystem of API tooling on the planet, thousands of developers are supporting Swagger
in almost every modern programming language and deployment environment.
With a Swagger-enabled API, you get interactive documentation, client SDK generation and discoverability.
We created Swagger to help fulfill the promise of APIs.
Swagger helps companies like Apigee, Getty Images, Intuit, LivingSocial, McKesson, Microsoft, Morningstar, and PayPal
build the best possible services with RESTful APIs.Now in version 2.0, Swagger is more enabling than ever.
And it's 100% open source software.
Install:
go get -u github.com/casualjim/go-swagger/cmd/swagger
The implementation also provides a number of command line tools to help working with swagger.
There is a spec validator tool:
swagger validate https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-expanded.json
You can also serve a swagger document with the swagger UI
swagger ui ./swagger.json
Generating code
You're free to add files to the directories the generated code lands in, but the files generated by the generator itself
will be regenerated on following generation runs so any changes to those files will be lost.
However extra files you create won't be lost so they are safe to use for customizing the application to your needs.
To generate a server for a swagger spec document:
swagger generate server -f ./swagger.json -A [application-name] [--principal [principal-name]] --with-ui
There are several other sub commands available for the generate command
operation: generates one or more models specified in the swagger definition
model: generates model files for one or more models specified in the swagger definition
support: generates the api builder and the main method
server: generates an entire server application
*/
package swagger