github.com/dhax/go-base@v0.0.0-20231004214136-8be7e5c1972b/routes.md (about) 1 # github.com/dhax/go-base 2 3 GoBase REST API. 4 5 ## Routes 6 7 <details> 8 <summary>`/*`</summary> 9 10 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 11 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 12 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 13 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 14 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 15 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 16 - **/*** 17 - _GET_ 18 - [SPAHandler.func1](/api/api.go#L101) 19 20 </details> 21 <details> 22 <summary>`/admin/*`</summary> 23 24 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 25 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 26 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 27 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 28 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 29 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 30 - **/admin/*** 31 - [RequiresRole.func1](/auth/authorizer.go#L11) 32 - **/** 33 - _GET_ 34 - [(*API).Router.func1](/api/admin/api.go#L42) 35 36 </details> 37 <details> 38 <summary>`/admin/*/accounts/*`</summary> 39 40 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 41 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 42 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 43 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 44 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 45 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 46 - **/admin/*** 47 - [RequiresRole.func1](/auth/authorizer.go#L11) 48 - **/accounts/*** 49 - **/** 50 - _GET_ 51 - [(*AccountResource).(github.com/dhax/go-base/api/admin.list)-fm](/api/admin/accounts.go#L50) 52 - _POST_ 53 - [(*AccountResource).(github.com/dhax/go-base/api/admin.create)-fm](/api/admin/accounts.go#L51) 54 55 </details> 56 <details> 57 <summary>`/admin/*/accounts/*/{accountID}/*`</summary> 58 59 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 60 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 61 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 62 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 63 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 64 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 65 - **/admin/*** 66 - [RequiresRole.func1](/auth/authorizer.go#L11) 67 - **/accounts/*** 68 - **/{accountID}/*** 69 - [(*AccountResource).(github.com/dhax/go-base/api/admin.accountCtx)-fm](/api/admin/accounts.go#L53) 70 - **/** 71 - _PUT_ 72 - [(*AccountResource).(github.com/dhax/go-base/api/admin.update)-fm](/api/admin/accounts.go#L55) 73 - _DELETE_ 74 - [(*AccountResource).(github.com/dhax/go-base/api/admin.delete)-fm](/api/admin/accounts.go#L56) 75 - _GET_ 76 - [(*AccountResource).(github.com/dhax/go-base/api/admin.get)-fm](/api/admin/accounts.go#L54) 77 78 </details> 79 <details> 80 <summary>`/api/*/account/*`</summary> 81 82 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 83 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 84 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 85 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 86 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 87 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 88 - **/api/*** 89 - **/account/*** 90 - [(*AccountResource).(github.com/dhax/go-base/api/app.accountCtx)-fm](/api/app/account.go#L48) 91 - **/** 92 - _PUT_ 93 - [(*AccountResource).(github.com/dhax/go-base/api/app.update)-fm](/api/app/account.go#L50) 94 - _DELETE_ 95 - [(*AccountResource).(github.com/dhax/go-base/api/app.delete)-fm](/api/app/account.go#L51) 96 - _GET_ 97 - [(*AccountResource).(github.com/dhax/go-base/api/app.get)-fm](/api/app/account.go#L49) 98 99 </details> 100 <details> 101 <summary>`/api/*/account/*/profile`</summary> 102 103 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 104 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 105 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 106 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 107 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 108 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 109 - **/api/*** 110 - **/account/*** 111 - [(*AccountResource).(github.com/dhax/go-base/api/app.accountCtx)-fm](/api/app/account.go#L48) 112 - **/profile** 113 - _PUT_ 114 - [(*AccountResource).(github.com/dhax/go-base/api/app.updateProfile)-fm](/api/app/account.go#L56) 115 116 </details> 117 <details> 118 <summary>`/api/*/account/*/token/{tokenID}/*`</summary> 119 120 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 121 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 122 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 123 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 124 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 125 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 126 - **/api/*** 127 - **/account/*** 128 - [(*AccountResource).(github.com/dhax/go-base/api/app.accountCtx)-fm](/api/app/account.go#L48) 129 - **/token/{tokenID}/*** 130 - **/** 131 - _PUT_ 132 - [(*AccountResource).(github.com/dhax/go-base/api/app.updateToken)-fm](/api/app/account.go#L53) 133 - _DELETE_ 134 - [(*AccountResource).(github.com/dhax/go-base/api/app.deleteToken)-fm](/api/app/account.go#L54) 135 136 </details> 137 <details> 138 <summary>`/auth/*/login`</summary> 139 140 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 141 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 142 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 143 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 144 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 145 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 146 - **/auth/*** 147 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 148 - **/login** 149 - _POST_ 150 - [(*Resource).(github.com/dhax/go-base/auth.login)-fm](/auth/api.go#L67) 151 152 </details> 153 <details> 154 <summary>`/auth/*/logout`</summary> 155 156 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 157 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 158 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 159 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 160 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 161 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 162 - **/auth/*** 163 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 164 - **/logout** 165 - _POST_ 166 - [Verifier.func1](/vendor/github.com/go-chi/jwtauth/jwtauth.go#L70) 167 - [AuthenticateRefreshJWT](/auth/authenticator.go#L66) 168 - [(*Resource).(github.com/dhax/go-base/auth.logout)-fm](/auth/api.go#L73) 169 170 </details> 171 <details> 172 <summary>`/auth/*/refresh`</summary> 173 174 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 175 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 176 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 177 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 178 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 179 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 180 - **/auth/*** 181 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 182 - **/refresh** 183 - _POST_ 184 - [Verifier.func1](/vendor/github.com/go-chi/jwtauth/jwtauth.go#L70) 185 - [AuthenticateRefreshJWT](/auth/authenticator.go#L66) 186 - [(*Resource).(github.com/dhax/go-base/auth.refresh)-fm](/auth/api.go#L72) 187 188 </details> 189 <details> 190 <summary>`/auth/*/token`</summary> 191 192 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 193 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 194 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 195 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 196 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 197 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 198 - **/auth/*** 199 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 200 - **/token** 201 - _POST_ 202 - [(*Resource).(github.com/dhax/go-base/auth.token)-fm](/auth/api.go#L68) 203 204 </details> 205 <details> 206 <summary>`/ping`</summary> 207 208 - [Recoverer](/vendor/github.com/go-chi/chi/middleware/recoverer.go#L18) 209 - [RequestID](/vendor/github.com/go-chi/chi/middleware/request_id.go#L63) 210 - [DefaultCompress](/vendor/github.com/go-chi/chi/middleware/compress.go#L38) 211 - [Timeout.func1](/vendor/github.com/go-chi/chi/middleware/timeout.go#L33) 212 - [RequestLogger.func1](/vendor/github.com/go-chi/chi/middleware/logger.go#L36) 213 - [SetContentType.func1](/vendor/github.com/go-chi/render/content_type.go#L49) 214 - **/ping** 215 - _GET_ 216 - [NewAPI.func2](/api/api.go#L73) 217 218 </details> 219 220 Total # of routes: 12