https://github.com/mudroljub/programming-quotes-api

Programming Quotes API for open source projects.
https://github.com/mudroljub/programming-quotes-api

api backend-api c-sharp quotes-api

Last synced: 2 months ago
JSON representation

Programming Quotes API for open source projects.

• Host: GitHub
• URL: https://github.com/mudroljub/programming-quotes-api
• Owner: mudroljub
• Created: 2018-01-31T10:51:04.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-13T10:15:08.000Z (11 months ago)
• Last Synced: 2024-04-12T12:08:10.252Z (9 months ago)
• Topics: api, backend-api, c-sharp, quotes-api
• Language: C#
• Homepage:
• Size: 924 KB
• Stars: 450
• Watchers: 9
• Forks: 63
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• my-awesome-github-stars - mudroljub/programming-quotes-api - Programming Quotes API for open source projects. (JavaScript)

README

        
# Programming Quotes API

**Programming Quotes API for open source projects.**

Status: [currently without free hosting](https://github.com/mudroljub/programming-quotes-api/issues/54). You can help the project by hosting this API.

## Introduction

This open source API provides a large collection of programming quotes and their authors. These can be searched and favoured. This allows the citations to be filtered according to personal preferences. Quotes can also be edited, created and deleted. 

Convention: Author names are as they are on Wikipedia.

## Development

First, set env variable `ProgrammingQuotesSecret` to any string you like (but not too short).

Then, start the project locally:

```

dotnet build

dotnet watch run

```

Listening on: http://localhost:5000 and https://localhost:5001

## API Documentation

GET `/quotes` (get all quotes)

GET `/quotes/random` (get random quote)

GET `/quotes/5a6ce86f2af929789500e824` (get quote by id)

GET `/quotes/author/Edsger W. Dijkstra` (get quote by author)

You can also POST, PUT, PATCH and DELETE. See Swagger docs for more.

## Author info

You can use Wikipedia API for author's image and info. 

To get author's image:

[`https://en.wikipedia.org/w/api.php?action=query&titles=Fred%20Brooks&prop=pageimages&format=json&pithumbsize=250`](https://en.wikipedia.org/w/api.php?action=query&titles=Fred%20Brooks&prop=pageimages&format=json&pithumbsize=250)

To get author info:

[`https://en.wikipedia.org/w/api.php?action=query&titles=Fred%20Brooks&prop=extracts&format=json&exintro=1`](https://en.wikipedia.org/w/api.php?action=query&titles=Fred%20Brooks&prop=extracts&format=json&exintro=1)

Note that you can change `titles`, `pithumbsize` and other params. The `%20` character (as in `Fred%20Brooks`) is for empty space.