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.103.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b44e5642d141bdbee4587dc0fdb16011e8e1e8e059d730046ebaba2b79ffa9f |
|
MD5 | 009fde9b82c7ab906fa9568b0b58d0f5 |
|
BLAKE2b-256 | 9222396a610dff7393893b282fdd8daed11563b1dcea351c609ed3b9c7e71644 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.103-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af659372052ec45ab4a2eb6c037c46f4819b2a3942db43889da03a835920410c |
|
MD5 | 6d3a299cdd8db075e18fb471a422199c |
|
BLAKE2b-256 | 3f0c33037abc6bf2b62f11f512c0c760acb00e989e617e6708088db480b673b5 |