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.588.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5c8059e403effb0ae242932fb7bba8f72ae530b7b74fa5d003b12bda0ea5f2e |
|
MD5 | 3acff070efff96f869661adfd0eeae3a |
|
BLAKE2b-256 | 2dfffb17f3ac7b0772891307ac9d888ed7b8e7d0062a738c9eb4fe3921d6e865 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.588-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b55afd0f786d2ddf362bd42d44464f7e53f881962717cd9de4a47fcd5bca765f |
|
MD5 | e322fdca165b07221cd9feab0b6e9eed |
|
BLAKE2b-256 | 4a733118fcad5e07bb5bce594b66f54d9fc239abeed78e86254a5cfd8580d824 |