mirror of https://github.com/vapor/docs.git
72 lines
2.0 KiB
Markdown
72 lines
2.0 KiB
Markdown
# Controllers
|
|
|
|
Controllers are a great way to organize your code. They are collections of methods that accept a request and return a response.
|
|
|
|
A good place to put your controllers is in the [Controllers](../getting-started/folder-structure.md#controllers) folder.
|
|
|
|
## Overview
|
|
|
|
Let's take a look at an example controller.
|
|
|
|
```swift
|
|
import Vapor
|
|
|
|
struct TodosController: RouteCollection {
|
|
func boot(routes: RoutesBuilder) throws {
|
|
let todos = routes.grouped("todos")
|
|
todos.get(use: index)
|
|
todos.post(use: create)
|
|
|
|
todos.group(":id") { todo in
|
|
todo.get(use: show)
|
|
todo.put(use: update)
|
|
todo.delete(use: delete)
|
|
}
|
|
}
|
|
|
|
func index(req: Request) async throws -> [Todo] {
|
|
try await Todo.query(on: req.db).all()
|
|
}
|
|
|
|
func create(req: Request) async throws -> Todo {
|
|
let todo = try req.content.decode(Todo.self)
|
|
try await todo.save(on: req.db)
|
|
return todo
|
|
}
|
|
|
|
func show(req: Request) async throws -> Todo {
|
|
guard let todo = try await Todo.find(req.parameters.get("id"), on: req.db) else {
|
|
throw Abort(.notFound)
|
|
}
|
|
return todo
|
|
}
|
|
|
|
func update(req: Request) async throws -> Todo {
|
|
guard let todo = try await Todo.find(req.parameters.get("id"), on: req.db) else {
|
|
throw Abort(.notFound)
|
|
}
|
|
let updatedTodo = try req.content.decode(Todo.self)
|
|
todo.title = updatedTodo.title
|
|
try await todo.save(on: req.db)
|
|
return todo
|
|
}
|
|
|
|
func delete(req: Request) async throws -> HTTPStatus {
|
|
guard let todo = try await Todo.find(req.parameters.get("id"), on: req.db) else {
|
|
throw Abort(.notFound)
|
|
}
|
|
try await todo.delete(on: req.db)
|
|
return .ok
|
|
}
|
|
}
|
|
```
|
|
|
|
Controller methods should always accept a `Request` and return something `ResponseEncodable`. This method can be asynchronous or synchronous.
|
|
|
|
|
|
Finally you need to register the controller in `routes.swift`:
|
|
|
|
```swift
|
|
try app.register(collection: TodosController())
|
|
```
|