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.155.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cce148af82939280eaa3bfd59dff43e61eeef8f93f7a69062e52b69295e2563d |
|
MD5 | 3b7c6702633a1d89198340e659d36251 |
|
BLAKE2b-256 | fdb7333648d6d3b64f83b98fd2f818023c6fac6c70c6da91677d478badff31bc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.155-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4278a7c663f69a89abfabf24cf32add86dd1c23430352593ead3b5bb33b07431 |
|
MD5 | eaeb0f59126d4b7e7052fd2a096ec785 |
|
BLAKE2b-256 | 18f797e07a51f55003716e1b7e62a65f0f52139e133081356b92edd5b251d2ae |