Skip to content
forked from fisenkodv/dictum

API to get access to the collection of the most inspiring expressions of mankind

License

Notifications You must be signed in to change notification settings

whoami15/dictum

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dictum · Travis CI GitHub Actions CodeQL Publish API To Docker Maintainability Test Coverage GitHub license

API to get access to the collection of the most inspiring expressions of mankind

API Methods

Get Random Quote

GET https://api.fisenko.net/quotes?l=[EN|RU]

Parameters

Parameter Type Description
l string optional language. By default is EN.

Example

request

GET https://api.fisenko.net/quotes

or

GET https://api.fisenko.net/quotes?l=en

returns

{
  "uuid": "l86O4m2Wez",
  "text": "Nothing is softer or more flexible than water, yet nothing can resist it.",
  "author": "Lao Tzu"
}

Get Quote By Id

GET https://api.fisenko.net/quotes/[uuid]

Parameters

Parameter Type Description
uuid string required unique quote's id.

Example

request

GET https://api.fisenko.net/quotes/l86O4m2Wez

returns

{
  "uuid": "l86O4m2Wez",
  "text": "Nothing is softer or more flexible than water, yet nothing can resist it.",
  "author": "Lao Tzu"
}

Get Quotes By Author UUID

GET https://api.fisenko.net/quotes/author/[uuid]?l=[EN|RU]&p=[page]&c=[count]

Parameters

Parameter Type Description
l string optional language. By default is EN.
uuid string required unique author's id.
p int optional page number. By default is 0
c int optional items per page. By default is 10. Could not be greater than 50

Example

request

GET https://api.fisenko.net/quotes/author/4PO19Pf6DR

returns

[
  {
    "uuid": "l86O4m2Wez",
    "text": "Nothing is softer or more flexible than water, yet nothing can resist it.",
    "author": "Lao Tzu"
  },
  {
    "uuid": "BqI18fmaGH",
    "text": "If you would take, you must first give, this is the beginning of intelligence.",
    "author": "Lao Tzu"
  }
]

Get Statistics

GET https://api.fisenko.net/statistics

Example

request

GET https://api.fisenko.net/statistics

returns

{
  "authors": {
    "total": 29573,
    "byLanguage": {
      "EN": 28203,
      "RU": 1370
    }
  },
  "quotes": {
    "total": 731144,
    "byLanguage": {
      "EN": 724315,
      "RU": 6829
    }
  }
}

Get Health

GET https://api.fisenko.net/health

Example

request

GET https://api.fisenko.net/health

returns

{
  "status": "Healthy",
  "errors": []
}

Links

License

MIT

About

API to get access to the collection of the most inspiring expressions of mankind

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 74.2%
  • TypeScript 17.8%
  • JavaScript 2.4%
  • HTML 2.1%
  • Dockerfile 1.2%
  • Shell 1.0%
  • Other 1.3%