3
3
3ton2015-10-28 15:10:43
API
3ton, 2015-10-28 15:10:43

How to document the project's API with the ability to support API versions?

There was a need to describe the functionality of the API for third-party developers.
They took it in Google and described it and everyone was fine until the API began to evolve.
I would like to know how to document the API with the ability to indicate changes on each branch

Answer the question

In order to leave comments, you need to log in

1 answer(s)
E
Edward Tibet, 2015-10-28
@eduardtibet

If we are talking about REST, then you can try the swagger editor + git + swagger ui bundle ( www.swagger.io ). If you like it, then:
- there is codegen
- all manual work will go to src
- it will directly generate from the code, like doxygen.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question