oasido / haparlament-api

API for getting random Haparlament sentences

Home Page:https://haparlament.ofekasido.xyz/api/sentence

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

shaoli-img

Haparlament-API

Haparlament-API is a simple API that spits out random unforgettable sentences from the Israeli comedy TV show, Haparlament / הפרלמנט.

Usage

The API is live for your convenience!

Get a random sentence by visiting https://haparlament.ofekasido.xyz/api/sentence (API was shutdown on the 31st of August)

URL

METHOD URL RESPONSE
GET /api/sentence Random sentence
GET /api/sentences/2 2 Random sentences

Success Response:

/api/sentence

Code: 200 OK
Content Example: "תראה את הגג זה מכפות רגליים של כלבים"

/api/sentences/2

Code: 200 OK
Content Example: [ "בזה של הלחם חיפשת?", "מה שממכר זה המצית" ]

Error Response:

Missing amount of sentences (e.g: GET /api/sentences/)

  • Code: 422 UNPROCESSABLE ENTRY
    Content: You need to specify an amount, e.g: /api/sentences/10

Installation

If you want to run this project on your own. Clone this project, cd into it and;

yarn install && yarn build && yarn start

Contributing

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

License

MIT

About

API for getting random Haparlament sentences

https://haparlament.ofekasido.xyz/api/sentence


Languages

Language:TypeScript 100.0%