Commit b22e3813 authored by Antoine Le Gonidec's avatar Antoine Le Gonidec

README — Add list of endpoints

parent d9cdeaa1
# ./play.it API
## Endpoints
### Games
#### Count
`/games/count`
Get count of supported games.
Example: http://api.dotslashplay.it/games/count
#### List
`/games/list`
Get list of supported games, including a screenshot thumbnail for each game.
Example: http://api.dotslashplay.it/games/list
#### Details
`/games/show/{id}`
Get details of game identified by numeric ID
Example: http://api.dotslashplay.it/games/show/57
`/games/collection/{game_id}`
Get details of games collection identified by game_id.
A game collection includes a base game and its DLCs.
Example: http://api.dotslashplay.it/games/collection/darkest-dungeon
`/games/search?search=$pattern`
Get list of games filtered by pattern
Example: http://api.dotslashplay.it/games/search?search=darkest%20dungeon
### Scripts
#### Count
`/scripts/count`
Get count of available scripts.
Example: http://api.dotslashplay.it/scripts/count
#### List
`/scripts/list`
Get list of available scripts.
Example: http://api.dotslashplay.it/scripts/list
#### Details
`/scripts/show/{id}`
Get details of script identified by numeric ID
Example: http://api.dotslashplay.it/scripts/show/58
### Archives
#### Count
`/archives/count`
Get count of supported archives.
Example: http://api.dotslashplay.it/archives/count
#### List
`/archives/list`
Get list of supported archives.
Example: http://api.dotslashplay.it/archives/list
#### Details
`/archives/show/{id}`
Get details of archive identified by numeric ID
Example: http://api.dotslashplay.it/archives/show/105
## Local installation instructions
1. Clone the repository locally
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment