Swagger Guide - cloud-barista/cb-spider GitHub Wiki
- Swagger-based REST API Documentation: since CB-Spider v0.9.4
| CB-Spider Swagger Info | Link |
|---|---|
| API Documentations | • https://github.com/cloud-barista/cb-spider/tree/master/api (for v0.12.0) |
| Swagger UI on Spider Server | • http://localhost:1024/spider/api |
| Cloud-Barista Swagger UI | • Cloud-Barista Swagger UI (for v0.12.0) |
-
1. Set up port forwarding (local:1024 → Spider Server:1024)
ssh -L 1024:localhost:1024 ubuntu@{spider_server_ip} -
2. Use Swagger UI to access/operate Remote Spider API
- • Browser: http://{spider_server_ip}:1024/spider/api
- Provides User Guide, Concept Guide, and other API-related guides
- Mainly referenced in Create API documents for resource creation
[Swagger UI: Example of API Overview & Usage Guide]