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.449.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bb3e48960d37ede1972210efc17b716a49cd766de64b5f4d9590a4da7b0378c |
|
MD5 | 8ade664a3aac70927ca39259d7198a39 |
|
BLAKE2b-256 | e7dafe4132e8beba7c2a7cb6fd23b7881e5420801213e05d84f57afeb6e621af |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.449-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01990ea88abf5c4c7d6a6a19ff2cc990db44e62e999c83be1ddf10e97a7fce07 |
|
MD5 | fdfc68b92b8c327e5403b459950b7853 |
|
BLAKE2b-256 | 1d0559d6cc45acdd3846c3d4572f258e62521a3de07acaedcac52aaa06755b09 |