Skip to content

Aggregates apidoc strings across multiple WolfBeacon Services serving entire API Documentation in one location

License

Notifications You must be signed in to change notification settings

wolfbeacon/wolfbeacon-apidoc-gen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WolfBeacon API Docs Generator

WolfBeacon has multiple services exposing different endpoints which make up the WolfBeacon API together. Documentation for every service is written is written using apidoc.

This service aggregates API Documentation written in the form of apidoc strings across these WolfBeacon microservices and serves them statically via a dead simple Node-Express server in one, well-formatted location.

Building and Running via Docker

  • sudo docker build -t wolfbeacon-apidoc-gen .
  • sudo docker run -p 3000:3000 wolfbeacon-apidoc-gen

Following this, the docs should be visible at yourhost:3000

About

Aggregates apidoc strings across multiple WolfBeacon Services serving entire API Documentation in one location

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published