Skip to content

plicca/summerfish-swagger

Repository files navigation

SummerFish

A refreshing way of handling swagger docs in Golang. Automatic documentation has arrived.

Description

With SummerFish we bring to Go developers a way of having swagger documentation auto-generated with no annotations needed!

This package contains a golang implementation of Swagger 2.0 (aka OpenAPI 2.0): it knows how to serialize and deserialize swagger specifications.

Swagger is a simple yet powerful representation of your RESTful API.

Features

summerfish-swagger brings to the go community a way of generating swagger documentation without needing any annotations or changes on the your code. It is also integrated with the Swagger UI to help you serving as one endpoint.

Example

You can check our live server docs at https://plicca.com/armadillo/docs/

Check out the example package to test with a minimum code example.

Project status

summerfish-swagger is still very early in its life.

Future features

  • Support more routers (currently we only support gorrila mux)
  • Increase test coverage
  • Your suggestion here :)

Help us out

Like this project? Feel free to create an issue, develop a new feature and contribute in any way to this project