swagger

package module
Version: v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 25, 2015 License: Apache-2.0 Imports: 0 Imported by: 0

README

Swagger 2.0 Circle CI Build status Slack Status

license GoDoc GitHub version

Development of this toolkit is sponsored by VMware:
VMWare

This API is not stable yet, when it is stable it will be distributed over gopkg.in

There is a code coverage report available in the artifacts section of a build. Unfortunately using coveralls made the build unstable.

Contains an implementation of Swagger 2.0. It knows how to serialize and deserialize 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.

Docs

https://goswagger.io

Install or update:

go get -u github.com/go-swagger/go-swagger/cmd/swagger

The implementation also provides a number of command line tools to help working with swagger.

Currently there is a spec validator tool:

    swagger validate https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-expanded.json

To generate a server for a swagger spec document:

    swagger generate server [-f ./swagger.json] -A [application-name [--principal [principal-name]]

To generate a client for a swagger spec document:

    swagger generate client [-f ./swagger.json] -A [application-name [--principal [principal-name]]

To generate a swagger spec document for a go application:

    swagger generate spec -o ./swagger.json

Much improved documentation is in the works and will actually explain how to use this tool in much more depth. To learn about which annotations are available and how to use them for generating a spec from any go application (generating a spec is not opinionated), you can take a look at the files used for testing the parser.

There are several other sub commands available for the generate command

    Sub command | Description
	------------|----------------------------------------------------------------------------------
	operation   | generates one or more operations 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
	client      | generates a client for a swagger specification
	spec        | generates a swagger spec document based on go code

Design

For now what exists of documentation on how all the pieces fit together, is described in this doc

What's inside?

For a V1 I want to have this feature set completed:

  • Documentation site
  • Play nice with golint, go vet etc.
  • An object model that serializes to swagger yaml or json
  • A tool to work with swagger:
    • validate a swagger spec document:
    • validate against jsonschema
    • validate extra rules outlined here
    • definition can't declare a property that's already defined by one of its ancestors (Error)
    • definition's ancestor can't be a descendant of the same model (Error)
    • each api path should be non-verbatim (account for path param names) unique per method (Error)
    • each security reference should contain only unique scopes (Warning)
    • each security scope in a security definition should be unique (Warning)
    • each path parameter should correspond to a parameter placeholder and vice versa (Error)
    • path parameter declarations do not allow empty names (/path/{} is not valid) (Error)
    • each definition property listed in the required array must be defined in the properties of the model (Error)
    • each parameter should have a unique name and in combination (Error)
    • each operation should have at most 1 parameter of type body (Error)
    • each operation cannot have both a body parameter and a formData parameter (Error)
    • each operation must have an unique operationId (Error)
    • each reference must point to a valid object (Error)
    • each referencable definition must have references (Warning)
    • every default value that is specified must validate against the schema for that property (Error)
    • every example that is specified must validate against the schema for that property (Error)
    • items property is required for all schemas/definitions of type array (Error)
    • serve swagger UI for any swagger spec file
  • code generation
    • generate api based on swagger spec
    • generate go client from a swagger spec
  • spec generation
    • generate spec document based on the code
    • generate meta data (top level swagger properties) from package docs
    • generate definition entries for models
      • support composed structs out of several embeds
      • support allOf for composed structs
    • generate path entries for routes
    • generate responses from structs
      • support composed structs out of several embeds
    • generate parameters from structs
      • support composed structs out of several embeds
  • Middlewares:
    • serve spec
    • routing
    • validation
    • additional validation through an interface
    • authorization
      • basic auth
      • api key auth
    • swagger docs UI
  • Typed JSON Schema implementation
    • JSON Pointer that knows about structs
    • JSON Reference that knows about structs
    • Passes current json schema test suite
  • extended string formats
    • uuid, uuid3, uuid4, uuid5
    • email
    • uri (absolute)
    • hostname
    • ipv4
    • ipv6
    • credit card
    • isbn, isbn10, isbn13
    • social security number
    • hexcolor
    • rgbcolor
    • date
    • date-time
    • duration
  • password
  • custom string formats

Later

After the v1 implementation extra transports are on the roadmap.

Many of these fall under the maybe, perhaps, could be nice to have, might not happen bucket:

  • Formats:
    • custom serializer for XML to support namespaces and prefixes
  • Tools:
    • Code generation:
      • generate "sensible" random data based on swagger spec
      • generate tests based on swagger spec for client
      • generate tests based on swagger spec for server
      • generate markdown representation of swagger spec
      • watch swagger spec file and regenerate when modified
    • Spec generation:
      • watch application folders and regenerate the swagger document
      • create fluent builder api
  • Middlewares:
    • swagger editor
    • swagger UI
    • authorization: - oauth2 - implicit - access code - password - application
  • Transports:
    • swagger socket (swagger over tcp sockets)
    • swagger websocket (swagger over websockets)
    • swagger proxy (assemble several backend apis into a single swagger spec and route the requests)
    • swagger discovery (repository for swagger specifications)

Documentation

Overview

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/go-swagger/go-swagger/cmd/swagger

The implementation also provides a number of command line tools to help working with swagger.

Currently there is a spec validator tool:

swagger validate https://raw.githubusercontent.com/swagger-api/swagger-spec/master/examples/v2.0/json/petstore-expanded.json

To generate a server for a swagger spec document:

swagger generate server [-f ./swagger.json] -A [application-name [--principal [principal-name]]

To generate a client for a swagger spec document:

swagger generate client [-f ./swagger.json] -A [application-name [--principal [principal-name]]

To generate a swagger spec document for a go application:

swagger generate spec -o ./swagger.json

There are several other sub commands available for the generate command

Sub command | Description
------------|----------------------------------------------------------------------------------
operation   | generates one or more operations 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
client      | generates a client for a swagger specification
spec        | generates a swagger spec document based on go code

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]]

Source Files

Directories

Path Synopsis
cmd
examples
generated/cmd/petstore-server
Package main Swagger Petstore This is a sample server Petstore server.
Package main Swagger Petstore This is a sample server Petstore server.
todo-list/cmd/simple-to-do-list-server
Package main Simple To Do List API Schemes: http https Version: 0.1.0 Consumes: - application/io.swagger.examples.todo-list.v1+json Produces: - application/io.swagger.examples.todo-list.v1+json swagger:meta
Package main Simple To Do List API Schemes: http https Version: 0.1.0 Consumes: - application/io.swagger.examples.todo-list.v1+json Produces: - application/io.swagger.examples.todo-list.v1+json swagger:meta
fixtures
bugs/84/cmd/event-list-server
Package main AttendList AttendList service.
Package main AttendList AttendList service.
goparsing/bookings
Package booking API.
Package booking API.
goparsing/classification
Package classification Petstore API.
Package classification Petstore API.
goparsing/petstore
Package petstore Petstore API.
Package petstore Petstore API.
Package generator provides the code generation library for go-swagger The general idea is that you should rarely see interface{} in the generated code.
Package generator provides the code generation library for go-swagger The general idea is that you should rarely see interface{} in the generated code.
client
Package client contains a client to send http requests to a swagger API.
Package client contains a client to send http requests to a swagger API.
middleware
Package middleware provides the library with helper functions for serving swagger APIs.
Package middleware provides the library with helper functions for serving swagger APIs.
Package scan provides a scanner for go files that produces a swagger spec document.
Package scan provides a scanner for go files that produces a swagger spec document.
Package strfmt contains custom string formats TODO: add info on how to define and register a custom format
Package strfmt contains custom string formats TODO: add info on how to define and register a custom format
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL