Which API documentation file best describes the request responses (GET, POST,...) #1400
Unanswered
Int-Circuit
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hello everyone,
I am currently building a software/middleware called PartDB-Driver to allow Part-DB to communicate with serial devices.
So far, I have implemented all API request (mostly) completely. What I'm currently trying to do is add a "dictionary" feature for the request's responces.
This would mean basically this:
Problem is that the *jsonapi requires post-processing and uses $ref tags. While I understand the use of the later to prevent duplication of api description, cJSON doesn't seems to understand $ref tags (or I missed something).
My question is the following: Is there a API doc file that easily documents all requests responses and in an mostly parse-able format that's better than the jsonopenapi file?
Thanks in advance for the help
Beta Was this translation helpful? Give feedback.
All reactions