A modern RESTful API built in Go, empowering users to create, manage, and explore bus routes with real-time mapping features via MapBox and secure JWT-based authentication.
Bus API enables developers and businesses to streamline route management for buses, shuttles, or similar transport services. With robust endpoints, seamless MapBox integration, and secure user authentication, it’s ready for production use or learning projects.
- Route Management: Create, update, delete, and retrieve bus routes.
- MapBox Integration: Visualize and manage routes on interactive maps.
- JWT Authentication: Secure all endpoints with JSON Web Tokens.
- RESTful API Design: Intuitive and standardized endpoints.
- Scalable Architecture: Built with Go for speed and reliability.
- Go (v1.18+ recommended)
- MapBox API Key
- (Optional) Docker for containerized deployment -- this is going to be added later please don't worry about this now
-
Clone the repository:
git clone https://github.com/AdamSoftware/BusAPI.git cd BusAPI -
Set Environment Variables:
Create a
.envfile with:MAPBOX_API_KEY=your_mapbox_key JWT_SECRET=your_jwt_secret -
Install dependencies:
go mod tidy
-
Run the application:
go run main.go
| Method | Endpoint | Description | Auth Required |
|---|---|---|---|
| POST | /signup |
Register a new user | ❌ |
| POST | /login |
Obtain JWT token | ❌ |
| GET | /routes |
List all routes | ✅ |
| POST | /routes |
Create a new route | ✅ |
| GET | /routes/{id} |
Get route details | ✅ |
| PUT | /routes/{id} |
Update a route | ✅ |
| DELETE | /routes/{id} |
Delete a route | ✅ |
All protected endpoints require an Authorization: Bearer <token> header.
- Register and log in to get a JWT token.
- Include the JWT token in the
Authorizationheader for all protected requests.
- Uses MapBox APIs to visualize and manage bus routes.
- Ensure you set your MapBox API key in the environment.
Pull requests are welcome! For major changes, please open an issue first to discuss your ideas.
MIT
Questions, suggestions, or want to collaborate?
Open an issue or email me at [AdamSteinberg16@gmail.com].
“The journey of a thousand miles begins with a single route.” 🚍