How to set a description for an API Gateway using the Serverless Framework?

Question

I want to do this in the serverless.yml file but can't find the way in the docs.

I'd like to avoid doing this after every deploy from the CLI with something like

aws apigateway update-rest-api --rest-api-id <id> --patch-operations op=replace,path=/description,value='description'

Answer 1

您是否尝试过serverless-aws-documentation插件？

Answer 2

If you are using REST API (API Gateway v1), you can simply write the following in your serverless.yml file.

provider:
  apiGateway:
    description: Your custom description

But I don't have a solution if you are using HTTP API (API Gateway v2)