Skip to content

Commit

Permalink
docs: add routing cheatsheet (#5605)
Browse files Browse the repository at this point in the history
  • Loading branch information
pmargreff authored Oct 31, 2023
1 parent 3fd5984 commit f9ceeaf
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 0 deletions.
83 changes: 83 additions & 0 deletions guides/cheatsheets/router.cheatmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Routing cheatsheet

> Those need to be declared in the correct router module and scope.

A quick reference to the common routing features' syntax. For an exhaustive overview, refer to the [routing guides](routing.md).

## Routing declaration
{: .col-2}

### Single route

```elixir
get "/users", UserController, :index
patch "/users/:id", UserController, :update
```
```elixir
# generated routes
~p"/users"
~p"/users/9" # user_id is 9
```
Also accepts `put`, `patch`, `options`, `delete` and `head`.

### Resources

#### Simple

```elixir
resources "/users", UserController
```
Generates `:index`, `:edit`, `:new`, `:show`, `:create`, `:update` and `:delete`.

#### Options

```elixir
resources "/users", UserController, only: [:show]
resources "/users", UserController, except: [:create, :delete]
resources "/users", UserController, as: :person # ~p"/person"
```

#### Nested

```elixir
resources "/users", UserController do
resources "/posts", PostController
end
```
```elixir
# generated routes
~p"/users/3/posts" # user_id is 3
~p"/users/3/posts/17" # user_id is 3 and post_id = 17
```
For more info check the [resources docs.](routing-1.html#resources)

### Scopes

#### Simple
```elixir
scope "/admin", HelloWeb.Admin do
pipe_through :browser

resources "/users", UserController
end
```
```elixir
# generated path helpers
~p"/admin/users"
```

#### Nested
```elixir
scope "/api", HelloWeb.Api, as: :api do
pipe_through :api

scope "/v1", V1, as: :v1 do
resources "/users", UserController
end
end
```
```elixir
# generated path helpers
~p"/api/v1/users"
```
For more info check the [scoped routes](routing.md#scoped-routes) docs.
2 changes: 2 additions & 0 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ defmodule Phoenix.MixProject do
"guides/howto/file_uploads.md",
"guides/howto/using_ssl.md",
"guides/howto/writing_a_channels_client.md",
"guides/cheatsheets/router.cheatmd",
"CHANGELOG.md"
]
end
Expand All @@ -184,6 +185,7 @@ defmodule Phoenix.MixProject do
"Real-time": ~r/guides\/real_time\/.?/,
Testing: ~r/guides\/testing\/.?/,
Deployment: ~r/guides\/deployment\/.?/,
Cheatsheets: ~r/guides\/cheatsheets\/.?/,
"How-to's": ~r/guides\/howto\/.?/
]
end
Expand Down

0 comments on commit f9ceeaf

Please sign in to comment.