Documentation Generation

[jpillora]

I'm thinking of using echo for a large project and one of the requirements will be extensive documentation, it would be nice to automatically keep the code and docs in sync with something like:

e := echo.New()
...
//with cli flag, or even via another REST endpoint
if generate {
  //json.MarshalIndent internal echo structures (fn name, methods, urls, params, middleware, etc.)
  b := e.GenerateSpec()
  //display
  os.Stdout.Write(b)
  //or, send to documentation server
  http.Post("...", "application/json", &bytes.NewBuffer(b))
}

Then the user could convert the structures into:

• a https://apiary.io/ API blueprint
• a http://swagger.io/ spec
• a https://github.com/mashery/iodocs spec

Thoughts?

[vishr]

Absolutely!

[jpillora]

Once this is ready, ill work on a module for converting what you provide into an Apiary API Blueprint 😄

[vishr]

@jpillora As we have decided to keep the framework minimal and flexible, I am open for suggestions that would help to generate docs using any library or framework - not tied to any!, it might imply that we will be just providing interfaces with some recipe code.

[jpillora]

No worries. Since creating this I'm just using a simple wrapper around httprouter.

[jpillora]

Thanks anyway :)