Loading repository data…
Loading repository data…
ImRLopezAG / repository
This is an API template made with express and typescript, to speed up your development, it contains repositories and generic services for the typical CRUD actions, based on a Sequelize model, we use it for data persistence
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
This is an API template made with express and typescript, to speed up your development, it contains repositories and generic services for the typical CRUD actions, based on a Sequelize model, we use it for data persistence
ORM: Sequelize
Language: Typescript
Framework: Express
Database: mySql
Deploy: Vercel,
Auth: JWT
Documentation: Swagger
git clone https://github.com/ImRLopezAG/Ts-Api-Template.git
cd my-project
npm install my-project
cd my-project
yarn install my-project
cd my-project
pnpm install my-project
you need to configure .env file like the .env.dev also you can add your configuration
Post /api/Auth/Login
| Body | Type | Description |
|---|---|---|
username | string | Required. username |
password | string | Required. password |
GET /api/Entity/List
GET /api/Entity/Get/${id}
| Parameter | Type | Description |
|---|---|---|
id | string | Required. Id of item to fetch |
Post /api/Entity/Create
| Body | Type | Description |
|---|---|---|
Entity Properties | Entity | Required. properties of item to fetch |
Put /api/Entity/Update
| Parameter | Type | Description |
|---|---|---|
id | string | Required. Id of item to update |
| Body | Type | Description |
|---|---|---|
Entity Properties | Entity | Required. properties of item to put |
Delete /api/Entity/Delete
| Parameter | Type | Description |
|---|---|---|
id | string | Required. Id of item to delete |
GET /api/User/List
GET /api/User/Get/${id}
| Parameter | Type | Description |
|---|---|---|
id | string | Required. Id of item to fetch |
GET /api/User/email/${email}
| Parameter | Type | Description |
|---|---|---|
email | string | Required. Id of item to fetch |
GET /api/User/username/${username}
| Parameter | Type | Description |
|---|---|---|
username | string | Required. Id of item to fetch |
Post /api/User/Create
| Body | Type | Description |
|---|---|---|
email | string | Required. |
username | string | Required. |
password | string | Required. |
Put /api/User/Update/${id}
| Parameter | Type | Description |
|---|---|---|
id | string | Required. |
| Body | Type | Description |
|---|---|---|
email | string | Required. |
username | string | Required. |
password | string | Required. |
Delete /api/User/Delete/${id}
| Parameter | Type | Description |
|---|---|---|
id | string | Required. |