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.74.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3b4ec9b85afeaf1e741fd385ef79902d9e5f4f9549be22df5c2993a7ac1949d |
|
MD5 | e078fe3554517ef60740fdeeb550a5b6 |
|
BLAKE2b-256 | 2305e4bbf97ccaf8fd5cde7f3e588081527b806c7ba1c16778b4ab537e2390a0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.74-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4fdaa91392e8c78bde9330814099ed8f0c61b6a0ce01c46816425e1226d95f7 |
|
MD5 | ef2b01891734d483e48487ac7ff22d1a |
|
BLAKE2b-256 | d74663b2af94d8373cacd521cf7e503e5fee45c2d362f5ae6c98b72167315c0d |