T
T
tigra2020-02-21 12:31:53
API
tigra, 2020-02-21 12:31:53

What to use for API documentation?

Now we use confluence for this business, but it's super inconvenient when you need to describe any method - I cry. I considered swagger, redoc, but these tools for the most part provide a visual representation of the json / yaml file that needs to be assembled in some kind of editor, and then loaded.
Is there something simpler? some kind of visual editor where a person can log in, add a section or a new method and quickly throw in an example request / response?
Or what does the correct documentation process usually look like in the same swagger in other companies?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
I
Ivan Shumov, 2020-02-21
@inoise

Now Swagger is the de facto standard (Apigee, of course, is generally a tower, but it stands like a wing from a Boeing). Most likely the lack of experience with him raises such doubts. There is SwaggerUI - you can run it on your server or use it as their service.
The ideal design is Top to bottom, when the specification is done first, and then the development goes on, but sometimes they make documentation in the code with annotations, which is collected in the final specification (I am against generating, but it happens normally)
The visual editor is a bit overkill because it was this format that showed maximum efficiency, especially since it is possible to link different files, compile a finished specification and one file, there are different UIs for presentation.
In general, I advise you to just try to describe 1-2 APIs in it in order to fill your hand and not refuse

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question