rakutentech / laravel-request-docs

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

Generate example with factory #355

Closed piovezanfernando closed 5 months ago

piovezanfernando commented 5 months ago

Firstly, thank you very much for the great tool you created and made available. Due to the necessity of my project, I need the examples to be generated exactly as the factories provide me, this way I avoid using false examples to consume my documentation. The possibility of disabling this process has been added for those who do not wish to use this tool. I didn't do the tests to cover it because I don't know exactly what the flow of this test looks like, if you could explain it to me I'll be happy to adjust the tests to cover this scenario. I have some other changes in the queue that I would like to make, so if it is of interest I will send more PR's to analyze the feasibility of implementation and if they do not find it viable, they can discard the PR.

kevincobain2000 commented 5 months ago

Interesting. Thanks. I am ok with your choice of implementation. Can you push another commit to address the comments and update README.md explaining the usage too?

Thanks, and I ll merge it within today.

kevincobain2000 commented 5 months ago

Sorry haven't pushed the new tag yet, as UT failed. https://github.com/rakutentech/laravel-request-docs/actions/runs/9172478571/job/25219068517 I'd need to revert this commit

kevincobain2000 commented 5 months ago

Can you re-open this PR with UT fixed? Thanks