Skip to content

Commit 1f6a507

Browse files
authored
feat: Use springwolf-ui only (#66)
1 parent a9f8ca6 commit 1f6a507

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/faq.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ sidebar_position: 80
1010

1111
Yes, you can use Springwolf for private and commercial purposes as long as you comply to the [Apache License 2.0](https://github.com/springwolf/springwolf-core/blob/master/LICENSE).
1212

13+
### Use `springwolf-ui` only (without plugins)
14+
15+
You can use `springwolf-ui` without any other Springwolf dependency.
16+
`springwolf-ui` will fetch any documentation available at the `springwolf/docs` path.
17+
It must be in `json` format (`yaml` isn't supported).
18+
19+
Either create a custom spring controller to serve the file or [serve static resources with spring](https://spring.io/guides/gs/serving-web-content/) and place your AsyncApi document into `resources/springwolf/docs` (without file extension).
20+
21+
Note: `springwolf-ui` doesn't support the full AsyncApi spec.
22+
1323
## Troubleshooting
1424

1525
### Show `debug` output in the logs

0 commit comments

Comments
 (0)