yaade icon indicating copy to clipboard operation
yaade copied to clipboard

Some Suggestions

Open beeing opened this issue 2 years ago • 2 comments

Hi team, thanks for this project. I have been looking for awhile on something like this and glad I stumbled on this project.

Would be great tool to use if we can include:

  1. documentation for each requests, possibly markdown friendly
  2. mock server facility so we can mock and add sample requests

With the above, it can be used as self-hosted stoplight.io

beeing avatar Apr 09 '22 03:04 beeing

Thank you for your comment. Could you elaborate a little bit more on that documentation feature. Would a simple tab called "Documentation" where a markdown editor sits be enough?

jonrosner avatar Apr 12 '22 20:04 jonrosner

Sorry for being too brief. What I observe on most API documentations have similar structure:

  • description - describe what the API does
  • request - the inputs such as params, query, headers, body
  • response - possible outputs from the API

IMO, markdown editor is sufficient with boxes for the above fields. Thanks in advance.

beeing avatar Apr 13 '22 00:04 beeing

@jonrosner I think a simple unopinionated "Documentation" tab using a markdown editor would be perfect, and probably easier to implement too? Fixed fields might be a bit too restrictive for certain use cases.

binaryfire avatar May 21 '23 07:05 binaryfire

A documentation tab was added in the most recent version.

jonrosner avatar Sep 13 '23 13:09 jonrosner