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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab23c22dbab6e30c2801878ef4a88a21d71de8bf5617c77b5bf3afb4aefc29a0 |
|
MD5 | ee30767057859177b1b332795b4cabd1 |
|
BLAKE2b-256 | f57e789d73fc2560cfdb4ca5cc9d9096d9285babe8cc8448163a5c98e64a0d0b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b471f67ecf9c6d6c0d40d60718faa1d40115d89b6802232c336e008c6a548fc |
|
MD5 | 9084af8708202eb9a1745b01925c459c |
|
BLAKE2b-256 | b3fa61c6c1ecd16ad4d7177504a3607d91d1a05cc436022e0ea083982f7bed79 |