Skip to content

Latest commit

 

History

4 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

JSON Lite API: Simplify Create's Your API

Introducing a streamlined API solution that makes creating APIs a breeze. With our platform, all you need to do is input your JSON data, and we'll take care of the rest. It's incredibly user- friendly and can be a valuable tool for your project.

Key Benefits:

  1. Effortless Setup: Say goodbye to complex API development. Our platform simplifies the process by letting you input your JSON data directly.

  2. User-Friendly: You don't need to be a coding expert to use our API solution. It's designed with ease of use in mind, making it accessible to everyone.

  3. Time-Saving: Eliminate the need for extensive coding and testing. You can have your API up and running in no time.

  4. Customization: Tailor your API to your specific needs by providing your JSON data.

Whether you're a seasoned developer or just starting with APIs, our JSON Lite API solution can help you quickly and efficiently create the API you need. Try it out today and experience the simplicity of API creation like never before.

Features

  • JWT Authentication: Secure user authentication with JSON Web Tokens to protect your API endpoints.
  • User Management: Endpoints for user signup, login, profile updates, and deletion.
  • CRUD Operations: Implement CRUD (Create, Read, Update, Delete) operations for your data entities.
  • Middleware: Utilizes Express middleware for authentication and request handling.
  • Modular Structure: Organized codebase with clear separation of concerns for easy maintenance and scalability.

Installation

Clone the repository:

git clone https://github.com/BengalByte/json-lite-api.git

Configure environment variables (e.g., database connection, JWT secret) in a .env file.

cd json-lite-api
npm install
npm run dev

Usage

Authentication

Signup:

Create a new user account by providing a username and password in the request body.

POST /api/signup

Login:

POST /api/login

Authenticate and receive a JWT token by providing valid credentials (username and password) in the request body.

User Management

Get User Profile:

bash

   GET /api/profile

Retrieve the user's profile information. Requires a valid JWT token.

Update User Profile:

bash

PATCH /api/profile

Update the user's profile information. Requires a valid JWT token.

Delete User Account:

bash

DELETE /api/profile

Delete the user's account and associated data. Requires a valid JWT token.

Data Operations Replace entity with the name of your data entity (e.g., products, users).

Get All Entities:

bash

GET /api/entity

Retrieve all entities of the specified type.

Get Single Entity:

bash

GET /api/entity/:id

Retrieve a single entity by its unique identifier.

Create Entity:

bash

POST /api/entity

Create a new entity by providing the necessary data in the request body.

Update Entity:

bash

PUT /api/entity/:id

Update an existing entity by providing the updated data in the request body.

Delete Entity:

bash

DELETE /api/entity/:id

Delete an entity by its unique identifier.

Contributing Feel free to contribute to the development of this API by opening issues or submitting pull requests. Your feedback and contributions are highly appreciated.

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors