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.110.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c8b30e22008b5707157ebc7e0ce5b0a263dbd9bd7328d58ced79570957f2e244 |
|
MD5 | 5ca0f70313a427892f4fa8139bc8a20c |
|
BLAKE2b-256 | b30cebdf1a86e33eeea054a53bb47ebfd8089161c0c0252c7254f3914fe59b76 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.110-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5440cd03d652fbf4c8abf11ff63197a3725fecfa37c808254ef5760b34cd0e4 |
|
MD5 | 0a36a8e284a59bb7ee6c2200f9b3505f |
|
BLAKE2b-256 | 86617df9858cd59f12e62b2945ddbe28a9802e7932492d17e483c3c10986c169 |