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.258.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5fdcb3b2be22804a8450a816a42b328d9ba3ddf050154e470053ba0e71b0578 |
|
MD5 | 3709caede4c6cfcf1a322ceeb9023ec7 |
|
BLAKE2b-256 | 09989e10ab2575829680e2562da29aed04adffdb41c37c92f9fa207958104e9b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.258-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 658fe0bc8d0d1f99b69cf7c819a64040e5c43d3dc4552106b7c9ca4557c0b183 |
|
MD5 | 984c68ec08c93f4db161049b1051465a |
|
BLAKE2b-256 | 82e51a8bc38632a0fb210293f75c47179be2b657aae9eab93a96e1ae812b5b6c |