Documentation
¶
Overview ¶
Package main implements the main start of API Scout
API Scout helps you catalog and document your Kubernetes microservices so you know what you've deployed last summer!
API Scout automatically discover microservices by using annotations * apiscout/index: This annotation ensures that apiscout indexes the service * apiscout/swaggerUrl: This is the URL from where apiscout will read the OpenAPI document
After discovery, API Scout generates pixel-perfect OAS/Swagger-based API Docs and displays it using a staticly generated site (powered by [Hugo](https://gohugo.io))
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package server implements the server of APIScout Package server implements the server of APIScout Package server implements the server of APIScout Package server implements the server of APIScout
|
Package server implements the server of APIScout Package server implements the server of APIScout Package server implements the server of APIScout Package server implements the server of APIScout |
|
Package util implements utility methods Package util implements utility methods Package util implements utility methods
|
Package util implements utility methods Package util implements utility methods Package util implements utility methods |
Click to show internal directories.
Click to hide internal directories.