search

rakutentech / laravel-request-docs

Effortless API documentation tool for Laravel applications. Swagger alternative.
MIT License
719 stars 106 forks source link

Generate Response Schema #279

Closed Rizki-SS closed 1 year ago

Rizki-SS commented 1 year ago

Hi, thanks for your package, it was very helpful in documenting my application.

Maybe this is related to issue #231, but it seems there is still no update about this(or actually already exist?). I feel I need a response schema so I don't need to make a request first to find out. If I only add it in the comments, sometimes I'm still wrong in determining the response schema (typo or wrong data type).

So I thought it might be easier to do as in issue #231. I also thought of adding some response schema based on the status code. image image

at least it helps to know and can be updated based on the given model, but I don't know the best way to display it image

I also don't know how to customize the export to openapi and I'm not sure, is the process that I made correct?

kevincobain2000 commented 1 year ago

Generating response schema automatically is not implemented. I am open to pull reqs.

r4m-sergeya commented 1 year ago

Hi @kevincobain2000, you says automatically response schema is not implemented, but can I annotate response schema manually by adding some annotations?

kevincobain2000 commented 1 year ago

@r4m-sergeya yiu can annotate but it doesn’t display on the UI.

You can however use @ lrd:start and add markdown which are displayed on the ui.