Applicable when
- API documentation is required
- Similar requirements present
Key features
- Modern UI
- "Try Out" feature (sample API invocation directly from the docs)
- Supports custom non-API topics (can be written in Markdown)
- Can be exported into static HTML bundle (with some hacks)
Implementation
- Download the latest release of the DapperDox from the http://dapperdox.io/download/downloads
- Unpack it into some folder (I will use Windows version and unpack into "docs" folder) to have exe file at this path: docs/dapperdox.exe
- Create your project folder: docs/slicom
- Create Swagger API specification and put it into docs/slicom/specifications/swagger.json (you can check example specification in docs/examples/specifications/petstore/swagger.json as a reference)
- Create custom topic file and put it into docs/slicom/assets/sections/sli-commerce/templates/guides/topic-1.md (note that sli-commerce path element is based on your API title)
- Modify run_example.bat like this:
.\dapperdox ^
-spec-dir=slicom\specifications ^
-bind-addr=0.0.0.0:3123 ^
-site-url=http://localhost:3123 ^
-force-specification-list=false ^
-theme=default ^
-author-show-assets=false ^
-assets-dir=slicom\assets
Navigate http://127.0.0.1:3123/ and you will see API docs with custom topics
To create a static content bundle use this command, while running your server:
wget -q -r -p -F -k -nH -x -P ./dir_to_save_in -E -D localhost http://localhost:3123/
Detailed documentation: http://dapperdox.io/docs/getting-started
Sample data from this article: https://drive.google.com/file/d/1jb0FCt9x_U0mVONps2gs6IkZ-E1Ap-3U/view?usp=sharing
Comments
0 comments
Please sign in to leave a comment.