docs

Automatically generate RESTful API documentation for GO projects - aligned with Open API Specification standard.

go-OAS Docs converts structured OAS3 (Swagger3) objects into the Open API Specification & automatically serves it on chosen route and port. It's extremely flexible and simple, so basically it can be integrated into any framework or existing project.

We invite anyone interested to join our GH Discussions board. Honest feedback will enable us to build better product and at the same time not waste valuable time and effort on something that might not fit intended usage. So if you can, please spare few minutes to give your opinion of what should be done next, or what should be the priority for our roadmap. 💪 🎉

---

Table of Contents

• Getting Started
• How to use
  • Examples
• Contact
• The current roadmap (planned features)

Getting Started

1. Download docs by using:

   $ go get -u github.com/go-oas/docs

2. Add one line annotation to the handler you wish to use in the following format: // @OAS <FUNC_NAME> <ROUTE> <HTTP_METHOD> Examples:

   // @OAS handleCreateUser /users POST
   // @OAS handleGetUser /users GET
   

3. Declare all required documentation elements that are shared. Or reuse ones that already exist in the examples directory.
4. Declare specific docs elements per route.

---

How to use

For more explicit example, please refer to docs/examples

Add OAS TAG to your existing handler that handles fetching of a User:

package users

import "net/http"

// @OAS handleGetUser /users GET
func (s *service) handleGetUser() http.HandlerFunc {
	return func(w http.ResponseWriter, r *http.Request) {
	}
}

Create a unique API documentation function for that endpoint:

package main

import "github.com/go-oas/docs"

func handleGetUserRoute(oasPathIndex int, oas *docs.OAS) {
	path := oas.GetPathByIndex(oasPathIndex)

	path.Summary = "Get a User"
	path.OperationID = "getUser"
	path.RequestBody = docs.RequestBody{}
	path.Responses = docs.Responses{
		getResponseOK(),
	}

	path.Tags = append(path.Tags, "pet")
}

Bear in mind that creating a unique function per endpoint handler is not required, but simply provides good value in usability of shared documentation elements.

Once you created the function, simply register it for parsing by using AttachRoutes() defined upon OAS structure. E.g.:

package main

import (
	"github.com/go-oas/docs"
)

func main() {
	apiDoc := docs.New()
	apiDoc.AttachRoutes([]interface{}{
		handleGetUserRoute,
	})

If this approach is too flexible for you, you are always left with the possibility to create your own attacher - or any other parts of the system for that matter.

Examples

To run examples, and checkout hosted documentation via Swagger UI, issue the following command:

$ go run ./examples/file_output/*.go
# or uncomment line 40 and comment line 38 in internal/dist/index.html before running:
$ go run ./examples/stream_output/*.go

And navigate to http://localhost:3005/docs/api/ in case that you didn't change anything before running the example above.

---

Contact

Check out the current Project board or our GH Discussions board for more information.

You can join our Telegram group at: https://t.me/go_oas

Roadmap

Feature (GH issues)	Description	Release
Validation	Add validation to all structures based on OAS3.0.3	v1.1.0
CLI	Add CLI support - make it CLI friendly	v1.2.0
Postman	Add postman support via PM API	v1.3.0
ReDoc	Add ReDoc support as an alternative to SwaggerUI	v1.4.0
E2E Auto-generation	Go tests conversion to Cypress/Katalon suites (convert mocked unit tests into e2e tests)	v1.5.0