Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/javiercbk/swago

Last synced: 28 days ago
JSON representation

Host: GitHub
URL: https://github.com/javiercbk/swago
Owner: javiercbk
License: unlicense
Created: 2020-02-12T01:09:06.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2023-01-17T17:36:55.000Z (almost 2 years ago)
Last Synced: 2024-06-19T16:30:08.981Z (6 months ago)
Language: Go
Size: 262 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Swago

Autogenerate the `swagger` documentation for your services

[Golangci report](https://golangci.com/r/github.com/javiercbk/swago)

## Wait what?

By reading the `ast` of your source files, `swago` attempts to extract the routes, the handlers of each route, the request and response model

## How does it perform such magic

Well, it is not THAT magic, but it is quite cool. By reading a config file, it will search for certain patterns in order to extract routes, handlers, request and response models.

It will search in every function of the project for patterns and autogenerate the `swagger.yml` file for you. As a developer, you only need to follow the same patterns over and over again, which is quite common in GO.