Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
JaredCE opened this issue Jun 11, 2022 · 1 comment
Open

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

JaredCE opened this issue Jun 11, 2022 · 1 comment

Comments

@JaredCE
Copy link

JaredCE commented Jun 11, 2022

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
Copy link

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
    

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants