Skip to content

API Project Template with Express.js and TypeScript

License

Notifications You must be signed in to change notification settings

lrbn86/api-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Title

This project

Table of Contents

Features

  • Feature 1
  • Feature 2

Getting Started

  • Contribute by creating issues and/or pull requests
  • See package.json for more project details such as script commands and dependencies

API Documentation

This a RESTful API. It works only with JSON when accepting requests and returning responses. It also uses standard HTTP response codes, authentication, and verbs.

Authentication & Authorization

This API uses - to authenticate clients and role-based access control (RBAC) to authorize clients on certain actions.

Endpoints

Endpoint Method Description Parameters Example Responses
/resources POST Create {""}
/resources GET Get all
/resources/:id GET Get by Id
/resources/:id PUT Update by Id
/resources/:id DELETE Delete by Id

License

This project is licensed under the MIT License. See LICENSE for the full license text.

About

API Project Template with Express.js and TypeScript

Resources

License

Stars

Watchers

Forks