Gathering detailed insights and metrics for @aws-prototyping-sdk/type-safe-api
The AWS PDK provides building blocks for common patterns together with development tools to manage and build your projects.
Installations
npm install @aws-prototyping-sdk/type-safe-apiDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
18.17.1
NPM Version
9.6.7
Score
42.3
Supply Chain
74.8
Quality
79.3
Maintenance
100
Vulnerability
77.3
License
Releases
543
Contributors
42
Unable to fetch Contributors
Languages
9
TypeScript
EJS
Mustache
Dockerfile
JavaScript
Java
Shell
Python
HTML
TypeScript (66.94%)
EJS (25.55%)
Mustache (6.44%)
Dockerfile (0.37%)
JavaScript (0.24%)
Java (0.21%)
Shell (0.15%)
Python (0.12%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
Download Statistics
Total Downloads
63,777
Last Day
4
Last Week
31
Last Month
213
Last Year
37,158
GitHub Statistics
Apache-2.0 License
398 Stars
786 Commits
78 Forks
9 Watchers
16 Branches
42 Contributors
Updated on Feb 12, 2025
Bundle Size
316.95 kB
Minified
87.92 kB
Minified + Gzipped
Maintainers
3
Package Meta Information
Latest Version
0.19.68
Package Id
@aws-prototyping-sdk/type-safe-api@0.19.68
Unpacked Size
6.47 MB
Size
1.29 MB
File Count
1,736
NPM Version
9.6.7
Node Version
18.17.1
Published on
Aug 24, 2023
Total Downloads
Cumulative downloads
Total Downloads
63,777
Last Day
33.3%
4
Compared to previous day
Last Week
-50.8%
31
Compared to previous week
Last Month
-63.8%
213
Compared to previous month
Last Year
39.6%
37,158
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
7
Peer Dependencies
4
Dev Dependencies
30
@aws-prototyping-sdk/nx-monorepo@aws-sdk/client-s3@types/fs-extra@types/jest@types/lodash@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parseraws-cdk-libcdk-nagconstructseslinteslint-config-prettiereslint-import-resolver-nodeeslint-import-resolver-typescripteslint-plugin-headereslint-plugin-importeslint-plugin-prettiergenerate-license-filejestjest-junitjsiijsii-diffjsii-docgenjsii-pacmaklicense-checkerprettierprojents-jesttypescript
Type Safe API
Define your APIs using Smithy or OpenAPI v3, and leverage the power of generated client and server types, infrastructure, documentation, and automatic input validation!
This package vends a projen project type which allows you to define an API using either Smithy or OpenAPI v3, and a construct which manages deploying this API in API Gateway, given an integration (eg a lambda) for every operation.
The project will generate "runtime" projects from your API definition in your desired languages, which can be utilised both client side for interacting with your API, or server side for implementing your API. The project also generates a type-safe CDK construct which ensures an integration is provided for every API operation.
Code is generated at build time, so when you change your API model, just rebuild and you'll see your changes reflected in the generated code.
Project Structure
The TypeSafeApiProject projen project will create the following directory structure within its outdir:
|_ model/
|_ src/
|_ main/
|_ smithy - your API definition if you chose ModelLanguage.SMITHY
|_ openapi - your API definition if you chose ModelLanguage.OPENAPI
|_ generated/
|_ runtime/ - generated types, client, and server code in the languages you specified
|_ typescript
|_ python
|_ java
|_ infrastructure/ - generated infrastructure (you'll find only one directory in here based on your chosen infrastructure language)
|_ typescript
|_ python
|_ java
|_ documentation/ - generated documentation in the formats you specified
|_ html2
|_ html_redoc
|_ plantuml
|_ markdown
|_ library/ - generated libraries if specified
|_ typescript-react-query-hooks
Getting Started
Please see the Getting Started Guide for how to get started!
Developer Guides
For more information about Type Safe API, take a look at the developer guides:
- Using Smithy
- Using OpenAPI
- Integrations
- Mocking Responses
- Authorizers
- Lambda Handlers
- React Query Hooks
- API Keys
Walkthroughs
For detailed end-to-end examples, take a look at the walkthroughs:
You can also check out the Frequently Asked Questions.
No vulnerabilities found.
No security vulnerabilities found.