New maintained and (hopefully) improved fork of this project

temando / serverless-openapi-documentation

Serverless 1.0 plugin to generate OpenAPI V3 documentation from serverless configuration

MIT License

93 stars 127 forks source link

New maintained and (hopefully) improved fork of this project #48

Open JaredCE opened 2 years ago

JaredCE commented 2 years ago

I've forked and hopefully improved upon this project here: https://github.com/JaredCE/serverless-openapi-documenter

Would love it if people started using this and giving me feedback. There might be some gotchas with a straightforward swap in your plugin, but i'm sure we can iron them out. I think anything less than serverless 2 will break, but if anyone can help find the kinks there, we can get it running for 1/2/3, but i am dependent on using node 14.

I've done a lot of cleaning up of being able to generate properly compliant openAPI 3.0.X schemas, but work still needs doing.

rovellipaolo commented 7 months ago

If you're also interested in uploading the documentation to AWS, have a look at: https://github.com/failsafe-engineering/serverless-aws-apigateway-documentation

Generate the documentation locally:

$ serverless generateDocumentation --outputFileName=openapi.json --exportType oas30

Upload the documentation to AWS:
```
$ serverless deploy
```

Download the documentation from AWS:

$ serverless downloadDocumentation --outputFileName=openapi.json --exportType oas30 --extensions integrations --extensions authorizers