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.750.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b5247f369438210a637da377b62d4205deca4b8725e346ac95dd7eaad685945 |
|
MD5 | 049a60142d7a94ea9b4d51dc7f6e7098 |
|
BLAKE2b-256 | 206a0e7f617776de234c56f6f668dcd3ce02f56d12330bddd4909b4eb39f32eb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.750-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bba0cdfadc205d1e4ca1fd3b10c14134bdeda432904037dd25db4fab7d430b0 |
|
MD5 | e9c6e2688797fe51ddfbc27820b91841 |
|
BLAKE2b-256 | d7b80d95418c3c8fcedc2a7e47745610ac264919d961bd7106d854a36a796f03 |