P
P
Pavel2016-10-14 12:16:05
API
Pavel, 2016-10-14 12:16:05

How to document API, client and server communication?

There is a problem with the documentation of client-server requests, namely with the fact that certain keys stand for.
Since changes occur in the project more often than you have time to open a text editor, the problem of versioning client-server REST requests arises. New keys are constantly added, old ones go away. And after a week you forget what's what.
We started using jsDoc (server on NodeJS), but maybe there is some special thing that would cling to the network, sniff the keys and offer a description?

Answer the question

In order to leave comments, you need to log in

2 answer(s)
I
Ilya Erokhin, 2016-10-17
@Carduelis

raml.org

V
vladar, 2016-10-21
@vladar

Hardly suitable for a project with an existing API, but may be useful for the future - graphql.org (documentation is automatic)

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question