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.481.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b39da6b6e7951be18294a3ed445d6cee15546a088b04809f8936f60ec92de138 |
|
MD5 | 410ed1862056899c541bb26e98cfa2dc |
|
BLAKE2b-256 | 0cd60097641712f30f383fe9a5d2efd713fcafd62a0054686fe136ae728a49bc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.481-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c589562f28017738b17a1e066c441ea5402807f6c58c3575936c689837ab20c |
|
MD5 | a229dc8cae718d7b04ff2dff620b9ce4 |
|
BLAKE2b-256 | d9ae21a8d64c3dd58168e532c5ae0e0f61de5281e8c008ca53fd5f3510966392 |