github.com/youssef1337/wikipedia-api

Wikipedia API

This is an API to get short descriptions of Wikipedia articles.

Available at https://wikipedia.youssefsobhy.com/api/v1

Documentation available at https://wikipedia.youssefsobhy.com/api/v1/docs/index.html

Table of contents

• Wikipedia API
  • Table of contents
  • Installation
  • Usage
  • API Reference and Documentation
  • Built With
  • Deployment
  • Monitoring
  • License
  • Authors and acknowledgment

Installation

• Make sure you have Golang installed on your machine (https://go.dev/doc/install)
• Clone the repository and change directory to the project

  git clone https://github.com/youssef1337/wikipedia-api.git
  cd wikipedia-api
  

• Install the dependencies

  go get -t ./...
  

• Run the server

  go run cmd/main.go
  

• Open your browser and go to http://localhost:3000 to see the API in action

Usage

• To get a short description of an article, send a GET request to http://localhost:3000/api/v1/search with the article name as a query parameter

  curl http://localhost:3000/api/v1/search?query=Yoshua_Bengio
  

• To check if the API is running, send a GET request to http://localhost:3000/api/v1

  curl http://localhost:3000/api/v1
  

API Reference and Documentation

• Wikipedia API - The Wikipedia API I used to get the short descriptions
• API Documentation - The API documentation of this project

Built With

• Golang - The programming language used
• Gin - The web framework used
• Swag - The API documentation generator used

Deployment

• Render - The cloud platform used to deploy the API
• Cloudflare - The service used to manage the DNS records

Monitoring

• UptimeRobot - The service used to monitor the API uptime and status

License

Apache License 2.0

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Authors and acknowledgment

• Youssef Sobhy - youssef1337