serverless-openapi-documentation icon indicating copy to clipboard operation
serverless-openapi-documentation copied to clipboard

New maintained and (hopefully) improved fork of this project

Open JaredCE opened this issue 3 years ago • 1 comments

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.

JaredCE avatar Jun 11 '22 13:06 JaredCE

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
    

rovellipaolo avatar Jan 12 '24 13:01 rovellipaolo