https://github.com/ompreetham/jobs-api
This API allows users to register, login, create, update, delete jobs, and get information about jobs.
https://github.com/ompreetham/jobs-api
api expressjs jwt mongodb nodejs rest-api swagger-ui
Last synced: 3 months ago
JSON representation
This API allows users to register, login, create, update, delete jobs, and get information about jobs.
- Host: GitHub
- URL: https://github.com/ompreetham/jobs-api
- Owner: OmPreetham
- License: mit
- Created: 2024-03-06T03:56:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-31T07:46:08.000Z (over 2 years ago)
- Last Synced: 2025-09-16T09:10:52.357Z (10 months ago)
- Topics: api, expressjs, jwt, mongodb, nodejs, rest-api, swagger-ui
- Language: JavaScript
- Homepage: https://jobs-api-ivr3.onrender.com
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# Jobs API
Welcome to the Jobs API! This API allows users to register, login, create, update, delete jobs, and get information about jobs.
## Getting Started
To get started with the API, follow these steps:
1. Clone this repository.
2. Install dependencies: `npm install`
3. Set up your environment variables:
- Create a `.env` file.
- MONGO_URI, JWT_SECRET, JWT_LIFETIME
4. Start the server: `npm start`
5. Explore the API using the provided Swagger UI documentation.
## Documentation
For detailed documentation on how to use the API, please refer to the Swagger UI documentation:
[Jobs API Documentation](https://the-jobs-api-15608e92fff8.herokuapp.com/)
## Features
- User Authentication: Register and login to manage jobs.
- CRUD Operations: Create, Read, Update, and Delete jobs.
- Secure Endpoints: Protected endpoints require authentication.
## Technologies Used
- Node.js
- Express.js
- MongoDB
- Swagger UI
- JWT for authentication
## API Endpoints
- POST /api/v1/auth/register: Register a new user.
- POST /api/v1/auth/login: Login an existing user.
- POST /api/v1/jobs: Create a new job.
- GET /api/v1/jobs: Get all jobs.
- GET /api/v1/jobs/{id}: Get a single job by ID.
- PATCH /api/v1/jobs/{id}: Update a job by ID.
- DELETE /api/v1/jobs/{id}: Delete a job by ID.
## License
This project is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.