https://github.com/bkawk/typescript-express-tsoa

TypeScript Express REST API Starting Point
https://github.com/bkawk/typescript-express-tsoa

codegen express nodejs openapi swagger swagger-codegen tsoa typescript

Last synced: about 2 months ago
JSON representation

TypeScript Express REST API Starting Point

• Host: GitHub
• URL: https://github.com/bkawk/typescript-express-tsoa
• Owner: bkawk
• License: mit
• Created: 2019-06-29T04:50:40.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T03:33:22.000Z (almost 2 years ago)
• Last Synced: 2024-04-17T05:48:42.452Z (8 months ago)
• Topics: codegen, express, nodejs, openapi, swagger, swagger-codegen, tsoa, typescript
• Language: TypeScript
• Homepage:
• Size: 1.46 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# typescript-express-tsoa

An API Starting point in Typescript & Express connecting to MongoDB. Self Generates Swagger document that can then be converted into an SDK in many languages.  

## Installation  

```

git clone https://github.com/bkawk/typeScript-express

npm install

mv .env.example .env 

```  

## Usage  

```

npm run build

npm run watch

```  

Swagger docs will be served to [http://127.0.0.1:8888/docs](http://127.0.0.1:8888/docs)

API Example Endpoints are accessable at [http://127.0.0.1:8888/user/register](http://127.0.0.1:8888/user/register)

WebSocket test at [http://127.0.0.1:8888/socket](http://127.0.0.1:8888/socket)

Modify example endpoints at ```/src/controllers/register``` and your routes file will be automatically updated when you run the server again via 

```

npm run watch

```

## SDK Languages

aspnetcore, csharp, csharp-dotnet2, dynamic-html, html, html2, java, jaxrs-cxf-client, jaxrs-cxf, inflector, jaxrs-cxf-cdi, jaxrs-spec, jaxrs-jersey, jaxrs-di, jaxrs-resteasy-eap, jaxrs-resteasy, spring, nodejs-server, openapi, openapi-yaml, kotlin-client, kotlin-server, php, python, python-flask, scala, scala-akka-http-server, swift3, swift4, typescript-angular

## Generate SDK

install [swagger-codegen](https://swagger.io/docs/open-source-tools/swagger-codegen/)

```

swagger-codegen generate -i swagger.json -l $language -o sdk/$language

```