Skip to content
This repository has been archived by the owner on Jul 23, 2021. It is now read-only.

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

Open
tomaszdudek7 opened this issue Aug 6, 2020 · 3 comments
Open

Comments

@tomaszdudek7
Copy link

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.
@adit-malik-synechron
Copy link

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

@joaoluizhilario
Copy link

+1 any solution or workaround to solve it ?

@paulalex
Copy link

+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.

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

No branches or pull requests

4 participants