This tutorial teaches the basics of building a web API with the Scala Play Framework.
In this tutorial, you learn how to:
- Create a web API project.
- Add a model class and a database context.
- Create a controller with CRUD methods.
- Configure routing, URL paths, and return values.
- Call the web API with Postman.
- In the end, you have a web API that can manage "to-do" items stored in a database.
Overview
This tutorial creates the following API:
API | Description | Request body | Response body |
---|---|---|---|
GET /api/todos | Get all to-do items | None | An array of to-do items |
GET /api/todos/{id} | Get an item by ID | None | To-do item |
POST /api/todos/add | Add a new item | To-do item | To-do item |
PUT /api/todos/{id} | Update an existing item | To-do item | None |
DELETE /api/todos/{id} | Delete an item | None | None |
The following diagram shows the architecture of the app.
Prerequisites
- SBT 1.3.3
- Scala 2.13.0
- Play Framework
Click Here for full documentation.