Rest API document

Question

Rest API document

degarajesh opened this issue 4 years ago · 3 comments

degarajesh commented 4 years ago

Hey is there a support for rest api doc ?

If it is there can you please share samples?

Answer 1 · 2020-08-11T14:28:04.000Z

Hi, what do you mean by "REST API doc"? Please elaborate.

Answer 2 · 2020-08-11T22:05:44.000Z

Thank you for the quick reply, I want to expose All the APIs in a document where consumer can use it referring to the document, in sofa-api I see that they are using swagger is there something like that here, basically consumers should be able to see what are all Available get and post operations and all the available query Parms and also requests and responses.

Answer 3 · 2020-08-12T12:43:43.000Z

We currently don't have support for Swagger auto-generation, although this feature is planned to be added in the future.

You can manually generate your own Swagger/OpenAPI documentation (yaml file) based on the manifest file and the expected parameters and responses of your GraphQL queries.