avbrocklehurst / goapidoc

Go API Doc allows you to automatically generate markdown documentation for your HTTP API from comments on http.Handlers.

Go API Doc

Go API Doc allows you to automatically generate markdown or HTML documentation for your HTTP API from comments on http.Handlers.

This is a package I am working on for fun and out of interest. It may at somepoint be worth using.

HTML design is heavily influenced by the awesome https://github.com/lord/slate

TODO:

• Document setup and usage process
• Create list of all th things I want to do and make them into issues to be worked on
• Parse markdown into beautiful documentation (mabye into slate)

goapidoc's Issues

Better param parsing

Currently, types are not parsed in the params section. This should be changed to be more like returns. However, there will need to more complex logic based on single or multiple params. Some thinking is needed for the best option.

Document how to use project

Currently, you can only use this tool if you dig through the source code to figure out how it works. Good documentation is needed to allow easy use for anyone, preferably with complete examples.

Better navigation on HTML docs

Improve the navigation so that it works more like Slates (exaple below)

Main points here are highlighting the current section, and dropping down a list of all endpoints in a section when active.