Laravel-apidoc-generator: Open API v3 Export Support

Created on 16 Dec 2019  路  6Comments  路  Source: mpociot/laravel-apidoc-generator

Feature Proposal

Similar to generating a postman collection, generate an Open API v3 spec json file.

Why

  1. Allows you to automatically generate SDKs for your API using tools like https://github.com/OpenAPITools/openapi-generator
  2. This format can be imported into a wider range of tools and online services i.e. Postman (ironically), Apiary, Stoplight, Readme.com
  3. Automatic validation of your documentation against your API using tools like Dredd
  4. While it is currently possible to use online tools to do this currently, this is a manual process which can't easily be built into a CI/CD pipeline. Specifically with step 3 which validates the docs against the API.

How
I am willing to write and maintain this (with contribution from my team at LuminateOne). However, I would like to know if the maintainers of this package would accept this feature. I know in the past this feature has been turned down. It would be good to keep this issue open to gauge support from the community about this feature request too.

Most helpful comment

@ScopeyNZ haven't started work on it yet but we've placed it in our pipeline for the next 1-2 months :)

All 6 comments

The other alternative is to fork this package to have an Open API v3 Spec compliant version

That's a perfectly reasonable option. I would probably use that fork. There's nothing preventing you from merging upstream fixes if your OpenAPI contribution is not accepted

@Humni Did you ever continue work on this?

@ScopeyNZ haven't started work on it yet but we've placed it in our pipeline for the next 1-2 months :)

Hi @Humni I'm closing this issue since I don't have the permissions to transfer to another repository. Scribe has been released now, so you should open this issue in that repo if you still think it's relevant.

Just came across this issue, and thought I'd mention that Scribe now has OpenAPI export support (for a very long time, actually).馃槄

Was this page helpful?
0 / 5 - 0 ratings

Related issues

christophemassin picture christophemassin  路  3Comments

wyq2214368 picture wyq2214368  路  3Comments

yaofong picture yaofong  路  3Comments

shankesgk2 picture shankesgk2  路  6Comments

ashokTagtaste picture ashokTagtaste  路  8Comments