An open API service indexing awesome lists of open source software.

https://github.com/sahasawat-boss/open-api

MyAPI is a free and open RESTful API project [ Stack: tidb, dbeaver, node, express , deployed: railway ]
https://github.com/sahasawat-boss/open-api

api-rest express freeapi mysql node railway tidb

Last synced: 9 months ago
JSON representation

MyAPI is a free and open RESTful API project [ Stack: tidb, dbeaver, node, express , deployed: railway ]

Awesome Lists containing this project

README

          

# 🚀 MyAPI - Free Open API by Boss

![Node.js](https://img.shields.io/badge/Node.js-Express-blue?style=flat-square)
![TiDB](https://img.shields.io/badge/Database-TiDB-blue?style=flat-square)
![DBeaver](https://img.shields.io/badge/DBMS-DBeaver-lightgrey?style=flat-square)
![Railway](https://img.shields.io/badge/Hosted%20on-Railway-green?style=flat-square)

## 📖 Overview
**MyAPI** is a free and open RESTful API project, built with **Node.js, Express, and TiDB**, designed to provide **sample user and post data**.
It is deployed on **Railway** and uses **TiDB** as a scalable cloud database, with **DBeaver** for database management.

🌍 **Live API URL**: [https://myapi-from-boss-free-use.up.railway.app](https://myapi-from-boss-free-use.up.railway.app)

## 📌 API Endpoints

### **🏠 Root - API Info**
- **GET** `/`
- Returns an **HTML page** listing available API endpoints.
- Try it: [View API Homepage](https://myapi-from-boss-free-use.up.railway.app/)

---
### **👤 Users Endpoint**
- **GET** `/users`
- Returns a list of **sample users** stored in the database.
- Example Response:
```json
[
{
"id": 1,
"name": "John Doe",
"detail": "Software developer from the USA.",
"age": 28,
"sex": "Male",
"birth": "1996-05-14"
},
...
]
👉 Try it: [View API Users](https://myapi-from-boss-free-use.up.railway.app/posts)

---
![Screenshot 2025-03-01 153027](https://github.com/user-attachments/assets/ad9cb955-db11-49bf-a4a0-8e35ae799b44)
![Screenshot 2025-03-01 113427](https://github.com/user-attachments/assets/e1891076-7bfa-450a-a84a-b768643964eb)