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.248.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2e8c24f437e280763058f9d853a9610bed8182330dc551965a5207e94dbfe93 |
|
MD5 | 5659b021f572edc137ff44e2d8428666 |
|
BLAKE2b-256 | dca8e1c68448252f612176e226ddeacbdae58c297e854ff4c1e03641fde25d3b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.248-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b817b442a4a7373db072d217e6de8f732a58bdd7d501c46c0012d3ff3fa5091 |
|
MD5 | 6494837875fc6333478a97105edb4152 |
|
BLAKE2b-256 | 1c11a9c53f8c470495d8046cb65e637041301372e32ae4265632d148fba8db3b |