README-API.md

Go M.U.D - API

• Getting Started
• How to Play
• API
• Design
• TODO

Dungeons

List dungeons:

• Response Schema

GET /api/v1/dungeons

Get dungeon:

• Response Schema

GET /api/v1/dungeons/{:dungeon_id}

Locations

List dungeon locations:

• Response Schema

GET /api/v1/dungeons/{:dungeon_id}/locations

Get dungeon location:

• Response Schema

GET /api/v1/dungeons/{:dungeon_id}/locations/{:location_id}

Characters

Create character:

• Request Schema
• Response Schema

POST /api/v1/characters

List characters:

• Response Schema

GET /api/v1/characters

Get character:

• Response Schema

GET /api/v1/characters/{:character_id}

Update a character:

📝 Unimplemented

• Request Schema
• Response Schema

PUT /api/v1/characters/{:character_id}

Dungeon characters

Dungeon instances are created to accomodate a maximum number of characters per dungeon.

Enter dungeon:

A character enters into a dungeon.

• Response Schema

POST /api/v1/dungeons/{:dungeon_id}/character/{:character_id}/enter

Exit dungeon:

A character exits from a dungeon.

• Response Schema

POST /api/v1/dungeons/{:dungeon_id}/character/{:character_id}/exit

Get dungeon character:

Lists the currently running dungeon instances.

• Response Schema

GET /api/v1/dungeons/{:dungeon_id}/characters/{:character_id}

Actions

Characters are controlled by performing actions.

Create a character action:

• Request Schema
• Response Schema

POST /api/v1/dungeons/{:dungeon_id}/characters/{:character}/actions