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

Does this work with monorepo and multiple serverless.yml files?

Open tomaszdudek7 opened this issue 4 years ago • 3 comments

I am looking for an easy way to document my API. This plugin looks great, but I have two concerns:

  • does it support multiple serverless.yml files? I have a monorepo strucutre, with ApiGatewayRestApiId and ApiGatewayRestApiRootResourceId being passed downstream to modules.
  • is it dead? last commit was merged 9 months ago. Not great, not terrible.

tomaszdudek7 avatar Aug 06 '20 12:08 tomaszdudek7

I have the same Issue I use the multirepo structure so the structure is MainAPI -serverless.yml -ServiceA --serverless.yml -ServiceB --serverless.yml

build step is cd MainAPI serverless deploy cd ServiceA serverless deploy cd .. cd ServiceB serverless deploy

All request and response are created and mapped properly but when I publish the documents from AWS API gateway (export swagger/openAPI 3 doc ) from stage. The summary, description and tags are only for present for Service B (or the last in sequence) Note: all API use the same shared API gateway

adit-malik-synechron avatar Sep 09 '20 20:09 adit-malik-synechron

+1 any solution or workaround to solve it ?

joaoluizhilario avatar Oct 29 '20 13:10 joaoluizhilario

+1 I have this exact same issue, I am building my API GW in terraform and pushing the values into SSM where they are retrieved from multiple serverless projects and whatever the last one to deploy is the only one which has documentation available.

Have any of you found a fix or workaround for this problem? I am considering writing the documentation by hand now as this plugin seems dead and if there is no fix for this is almost useless for me anyway. I might use it to generate my docs on a per API basis and then add them to each project manually and update the documentation in my pipeline using the AWS cli.

paulalex avatar Nov 11 '20 19:11 paulalex