Search code examples
apiapiblueprint

Produce API docs via code using API Blueprint

Is it possible to produce/generate documentation using API Blueprint tool from Restful API code and If so how to use this tool any help?

Solution

  • If you are looking for a way how to generate a description of your API from the code then API Blueprint isn't probably the best choice as we believe it should represent the contract between everybody involved in the API design lifecycle. This is also the reason why we have built the testing tool – Dredd – https://github.com/apiaryio/dredd

    With Dredd you can test your API implementation is matching to your blueprint. It wouldn't make much sense if the blueprint would be generated from the implementation.

    Hope this does clarify.