Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hoseungme/typed-express
Make express.js fully-typed and serve automatically generated OpenAPI Specification object
https://github.com/hoseungme/typed-express
expressjs nodejs openapi server typescript
Last synced: about 2 months ago
JSON representation
Make express.js fully-typed and serve automatically generated OpenAPI Specification object
- Host: GitHub
- URL: https://github.com/hoseungme/typed-express
- Owner: hoseungme
- Created: 2021-12-18T18:28:31.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-01-04T16:58:24.000Z (about 3 years ago)
- Last Synced: 2024-11-14T13:50:08.127Z (2 months ago)
- Topics: expressjs, nodejs, openapi, server, typescript
- Language: TypeScript
- Homepage:
- Size: 1.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# typed-express
[](https://badge.fury.io/js/typed-express)
[](https://badgen.net/npm/dt/typed-express)
Make express.js fully-typed and serve automatically generated OpenAPI Specification object.
## Features
- [Create Routes](#create-routes)
- [Fully-Typed Request Parameters And Response Body](#fully-typed-request-parameters-and-response-body)
- [Request Parameters Validation](#request-parameters-validation)
- [OpenAPI Route](#openapi-route)
## Create Routes
- use ```Switch``` and ```Route``` to create routes.
- use ```Parameter``` and ```Schema``` to define request parameter / response body schema.
- if you need, you can pass middlewares.
```typescript
export const PostRouter = new Switch("/posts", [
Route.GET(
"/{id}",
"getPost",
{
id: Parameter.Path(Schema.String()),
},
Schema.Object({
id: Schema.String(),
title: Schema.String(),
content: Schema.String(),
}),
async (req, res) => {
/* ... */
},
{ middlewares: [/* ... */] } // This is optional
)
]);
```
## Fully-Typed Request Parameters And Response Body
request parameters and response body type are fully-typed.
## Request Parameters Validation
typed-express automatically validates request parameters.
for example, assume that you define router below,
```typescript
new Switch("/users", [
Route.GET(
"/{id}",
"getUser",
{
id: Parameter.Path(Schema.Number()),
},
Schema.Object({
id: Schema.String(),
name: Schema.String(),
}),
async (req, res) => {
/* ... */
},
),
]);
```
and then you create an invalid request like ```GET /users/asdf```, you'll get 400 response with error message(s).
```
parameter [id]: should be number
```
## OpenAPI Route
you can create OpenAPI Specification and serve it by using ```OpenAPIRoute```.
```typescript
const AllRouter = new Switch("/", [
PostRouter,
CategoryRouter,
]);
const OpenAPI = new OpenAPIRoute(
"/openapi",
{
title: "hoseungJangBlogAPI",
version: "1.0.0",
},
AllRouter,
Entities
);
export const RootRouter = new Switch("/", [
OpenAPI,
AllRouter,
]);
```
if user requests to ```/openapi``` in the code above, OpenAPIRoute returns automatically generated OpenAPI Specification object.