https://github.com/satyam4229/programming-language-api
This Flask-based API provides detailed information about various programming, markup, and database languages. The API allows users to retrieve data about different languages, including their descriptions, use cases, and key features.
https://github.com/satyam4229/programming-language-api
api flask flask-api python python-script rest-api
Last synced: 2 months ago
JSON representation
This Flask-based API provides detailed information about various programming, markup, and database languages. The API allows users to retrieve data about different languages, including their descriptions, use cases, and key features.
- Host: GitHub
- URL: https://github.com/satyam4229/programming-language-api
- Owner: Satyam4229
- License: apache-2.0
- Created: 2025-03-11T16:12:44.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-11T16:38:46.000Z (10 months ago)
- Last Synced: 2025-06-03T11:08:29.757Z (7 months ago)
- Topics: api, flask, flask-api, python, python-script, rest-api
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Programming Language API
This API provides information about various programming languages, including database languages, markup languages, and scripting languages. It is deployed on Render and can be accessed using the following endpoints.
## API Endpoints
### 1. Get All Programming Languages
**Endpoint:**
```http
GET https://programming-language-api.onrender.com/api/languages
```
**Description:**
Retrieves a list of all available programming languages with their details.
---
### 2. Get a Programming Language by Index
**Endpoint:**
```http
GET https://programming-language-api.onrender.com/api/languages/{index}
```
**Description:**
Retrieves the programming language at the specified index in the dataset.
**Example Request:**
```http
GET https://programming-language-api.onrender.com/api/languages/5
```
**Response:**
```json
{
"name": "Python",
"type": "Programming Language",
"paradigm": "Object-Oriented, Functional, Procedural",
"description": "Python is an interpreted, high-level programming language known for its simplicity and readability."
}
```
---
### 3. Get a Programming Language by Name
**Endpoint:**
```http
GET https://programming-language-api.onrender.com/api/languages/{language-name}
```
**Description:**
Retrieves details of a specific programming language by its name.
**Example Request:**
```http
GET https://programming-language-api.onrender.com/api/languages/python
```
**Response:**
```json
{
"name": "Python",
"type": "Programming Language",
"paradigm": "Object-Oriented, Functional, Procedural",
"description": "Python is an interpreted, high-level programming language known for its simplicity and readability."
}
```
---
## Setup and Deployment
### 1. Clone the Repository
```sh
git clone https://github.com/Satyam4229/Programming-Language-API.git
cd Programming-Language-API
```
### 2. Install Dependencies
```sh
pip install -r requirements.txt
```
### 3. Run the API Locally
```sh
python app.py
```
The API will be available at `http://127.0.0.1:5000`.
---
## Hosting on Render
This API is hosted on **Render** and can be accessed using the URLs mentioned in the **API Endpoints** section.
To deploy it on Render, follow these steps:
1. Push your latest code to GitHub.
2. Go to [Render](https://render.com/) and create a new **Web Service**.
3. Connect your GitHub repository.
4. Set the **Build Command**: `pip install -r requirements.txt`
5. Set the **Start Command**: `gunicorn app:app`
6. Deploy the service.
---
## Contributing
Feel free to contribute by submitting issues or pull requests on GitHub.
---
## License
This project is licensed under the **MIT License**.
---
## Contact
For any queries or suggestions, reach out via:
- GitHub: [Satyam4229](https://github.com/Satyam4229)
- Email: psatyam4229@gmail.com