1# github.com/go-chi/chi
2
3Welcome to the chi/_examples/rest generated docs.
4
5## Routes
6
7<details>
8<summary>`/`</summary>
9
10- [RequestID](/middleware/request_id.go#L63)
11- [Logger](/middleware/logger.go#L26)
12- [Recoverer](/middleware/recoverer.go#L18)
13- [URLFormat](/middleware/url_format.go#L45)
14- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
15- **/**
16 - _GET_
17 - [main.main.func1](/_examples/rest/main.go#L69)
18
19</details>
20<details>
21<summary>`/admin/*`</summary>
22
23- [RequestID](/middleware/request_id.go#L63)
24- [Logger](/middleware/logger.go#L26)
25- [Recoverer](/middleware/recoverer.go#L18)
26- [URLFormat](/middleware/url_format.go#L45)
27- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
28- **/admin/***
29 - [main.AdminOnly](/_examples/rest/main.go#L238)
30 - **/**
31 - _GET_
32 - [main.adminRouter.func1](/_examples/rest/main.go#L225)
33
34</details>
35<details>
36<summary>`/admin/*/accounts`</summary>
37
38- [RequestID](/middleware/request_id.go#L63)
39- [Logger](/middleware/logger.go#L26)
40- [Recoverer](/middleware/recoverer.go#L18)
41- [URLFormat](/middleware/url_format.go#L45)
42- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
43- **/admin/***
44 - [main.AdminOnly](/_examples/rest/main.go#L238)
45 - **/accounts**
46 - _GET_
47 - [main.adminRouter.func2](/_examples/rest/main.go#L228)
48
49</details>
50<details>
51<summary>`/admin/*/users/{userId}`</summary>
52
53- [RequestID](/middleware/request_id.go#L63)
54- [Logger](/middleware/logger.go#L26)
55- [Recoverer](/middleware/recoverer.go#L18)
56- [URLFormat](/middleware/url_format.go#L45)
57- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
58- **/admin/***
59 - [main.AdminOnly](/_examples/rest/main.go#L238)
60 - **/users/{userId}**
61 - _GET_
62 - [main.adminRouter.func3](/_examples/rest/main.go#L231)
63
64</details>
65<details>
66<summary>`/articles/*`</summary>
67
68- [RequestID](/middleware/request_id.go#L63)
69- [Logger](/middleware/logger.go#L26)
70- [Recoverer](/middleware/recoverer.go#L18)
71- [URLFormat](/middleware/url_format.go#L45)
72- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
73- **/articles/***
74 - **/**
75 - _GET_
76 - [main.paginate](/_examples/rest/main.go#L251)
77 - [main.ListArticles](/_examples/rest/main.go#L117)
78 - _POST_
79 - [main.CreateArticle](/_examples/rest/main.go#L158)
80
81</details>
82<details>
83<summary>`/articles/*/search`</summary>
84
85- [RequestID](/middleware/request_id.go#L63)
86- [Logger](/middleware/logger.go#L26)
87- [Recoverer](/middleware/recoverer.go#L18)
88- [URLFormat](/middleware/url_format.go#L45)
89- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
90- **/articles/***
91 - **/search**
92 - _GET_
93 - [main.SearchArticles](/_examples/rest/main.go#L152)
94
95</details>
96<details>
97<summary>`/articles/*/{articleID}/*`</summary>
98
99- [RequestID](/middleware/request_id.go#L63)
100- [Logger](/middleware/logger.go#L26)
101- [Recoverer](/middleware/recoverer.go#L18)
102- [URLFormat](/middleware/url_format.go#L45)
103- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
104- **/articles/***
105 - **/{articleID}/***
106 - [main.ArticleCtx](/_examples/rest/main.go#L127)
107 - **/**
108 - _DELETE_
109 - [main.DeleteArticle](/_examples/rest/main.go#L204)
110 - _GET_
111 - [main.GetArticle](/_examples/rest/main.go#L176)
112 - _PUT_
113 - [main.UpdateArticle](/_examples/rest/main.go#L189)
114
115</details>
116<details>
117<summary>`/articles/*/{articleSlug:[a-z-]+}`</summary>
118
119- [RequestID](/middleware/request_id.go#L63)
120- [Logger](/middleware/logger.go#L26)
121- [Recoverer](/middleware/recoverer.go#L18)
122- [URLFormat](/middleware/url_format.go#L45)
123- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
124- **/articles/***
125 - **/{articleSlug:[a-z-]+}**
126 - _GET_
127 - [main.ArticleCtx](/_examples/rest/main.go#L127)
128 - [main.GetArticle](/_examples/rest/main.go#L176)
129
130</details>
131<details>
132<summary>`/panic`</summary>
133
134- [RequestID](/middleware/request_id.go#L63)
135- [Logger](/middleware/logger.go#L26)
136- [Recoverer](/middleware/recoverer.go#L18)
137- [URLFormat](/middleware/url_format.go#L45)
138- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
139- **/panic**
140 - _GET_
141 - [main.main.func3](/_examples/rest/main.go#L77)
142
143</details>
144<details>
145<summary>`/ping`</summary>
146
147- [RequestID](/middleware/request_id.go#L63)
148- [Logger](/middleware/logger.go#L26)
149- [Recoverer](/middleware/recoverer.go#L18)
150- [URLFormat](/middleware/url_format.go#L45)
151- [SetContentType.func1](https://github.com/go-chi/render/content_type.go#L49)
152- **/ping**
153 - _GET_
154 - [main.main.func2](/_examples/rest/main.go#L73)
155
156</details>
157
158Total # of routes: 10
159
View as plain text