Git Product home page Git Product logo

base-template-express-api's Introduction

Express Api

Social Api is an example of a working version of api for a social network on Node Express

Used:
  • Express
  • MongoDB
  • Mongoose
  • Babel 7
  • Mocha

Installation

npm install
npm -g eslint

Create .env file

MONGO_TEST_URI=mongodb+srv://<user>:<password>@<host>/<collection>
MONGO_URI=mongodb+srv://<user>:<password>@<host>/<collection>
SESSION_SECRET=secret
NODE_ENV=test

Usage

npm run start

Testing

npm run test
npm run test:watch

Eslint

npm run lint
npm run lint:fix

Routes:

Auth:

  • POST: /auth/login login with
{"email": "string", "password": "string"}
  • GET: /auth/logout logout
  • POST: /auth/signup SignUp with
{"email": "string", "password": "string", "name": "string", "lastName": "string"}

Users:

  • GET: /users/me get current user
  • GET: /users/:userId get user by Id
  • GET: /users/ find all users

Posts:

  • POST: /posts/ create new post form user
{"title": "string", "body": "string"}
  • GET: /posts/:postId get posts by Id
  • GET: /posts/user/:userId get posts by userId
  • GET: /posts/ find all posts
  • POST: /posts/:postId/up upVote post by postId
  • POST: /posts/:postId/down downVote post by postId

API:

Auth:

  • POST: /api/auth/login login with
{"email": "string", "password": "string"}
  • GET: /api/auth/logout logout
  • GET: /api/auth/logoutall logout on all devices
  • POST: /api/auth/signup SignUp with
{"email": "string", "password": "string", "name": "string", "lastName": "string"}

With Bearer Authorization

Users:

  • GET: /api/users/me get current user
  • GET: /api/users/:userId get user by Id
  • GET: /api/users/ find all users

Posts:

  • POST: /api/posts/ create new post form user
{"title": "string", "body": "string"}
  • GET: /api/posts/:postId get posts by Id
  • GET: /api/posts/user/:userId get posts by userId
  • GET: /api/posts/ find all posts
  • POST: /api/posts/:postId/up upVote post by postId
  • POST: /api/posts/:postId/down downVote post by postId

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

medicalShopApi

chatapp-server

base-template-express-api's People

Contributors

piyas1234 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.