Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.763.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fcb91bbd0a055d15b64e043eb6098d2af43331b513ed10d83b92d0115a9d9d8d |
|
MD5 | 8045b96081a9167ba113f47d731fe0bc |
|
BLAKE2b-256 | ab4de96e91531fa8f158fae9efdf1a3db0245f4bfd89b14958e9808856eb7ffe |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.763-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09ab7ca361fdeae969a3dbc7f86980c45c18dc222ea515453cad86b50c736e60 |
|
MD5 | 13b104c6eea6f61d77a3de6cb06ea322 |
|
BLAKE2b-256 | fd2b50e29ead64883b0ae59c2f544cbf06d32dd71e8a43965db30b6eeb86a437 |