Skip to content

Commit 6499d53

Browse files
authored
doc(main): Updated documentation (#80)
1 parent 389020f commit 6499d53

12 files changed

+1013
-6
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
13.6 KB
Loading

docs/tutorials/http-application.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,13 @@ From there, you can get:
100100
- access to the configured health check endpoints
101101
- access to the loaded modules information (when exposed)
102102

103+
Here we can see for example the [fxhttpserver](../modules/fxhttpserver.md) information in the `Modules` section:
104+
105+
- server port
106+
- active routes
107+
- error handler
108+
- etc
109+
103110
See [fxcore](../modules/fxcore.md) documentation for more information.
104111

105112
## Application implementation
@@ -917,11 +924,11 @@ Yokai's [bootstrapper](../modules/fxcore.md#bootstrap) provides a `RunTest()` fu
917924

918925
This will automatically set the env var `APP_ENV=test`, and will [load your test configuration](../modules/fxconfig.md#dynamic-env-overrides).
919926

920-
For our tests:
927+
For our tests, we can configure:
921928

922-
- we can configure the [fxlog](../modules/fxlog.md#testing) module to send logs to a `test buffer`
923-
- we can configure the [fxtrace](../modules/fxtrace.md#testing) module to send trace spans to a `test exporter`
924-
- we can configure the [fxorm](../modules/fxorm.md#testing) module to use an [SQLite database](https://www.sqlite.org/index.html), in memory, to make our tests easily portable on any CI pipeline (no need to spin up a MySQL instance)
929+
- the [fxlog](../modules/fxlog.md#testing) module to send logs to a `test buffer`
930+
- the [fxtrace](../modules/fxtrace.md#testing) module to send trace spans to a `test exporter`
931+
- the [fxorm](../modules/fxorm.md#testing) module to use an [SQLite database](https://www.sqlite.org/index.html), in memory, to make our tests easily portable on any CI pipeline (no need to spin up a MySQL instance)
925932

926933
Let's set the testing configuration in `config/config.test.yaml` and activate the `debug`:
927934

@@ -973,7 +980,7 @@ This will enable your tests to use the SQLite database automatically with the sc
973980

974981
We can now provide `functional` tests for your application endpoints.
975982

976-
Let's create our `ListGopherHandler` test in the `gopher_test` package:
983+
Let's create our `TestListGophersHandlerSuccess` test in the `gopher_test` package:
977984

978985
```go title="internal/handler/gopher/list_test.go"
979986
package gopher_test

0 commit comments

Comments
 (0)