Swagger Guide

[CB-Spider Swagger 제공 정보]

• Swagger-based REST API Documentation: since CB-Spider v0.9.4

CB-Spider Swagger Info	Link
API documentation	• https://github.com/cloud-barista/cb-spider/tree/master/api
Spider Swagger UI	• http://localhost:1024/spider/api • http://spider_server_ip:1024/spider/api
Barista Swagger UI	• Barista Swagger UI

※ 참고: Swagger UI에서 Remote Spider 서버 활용 가이드

• 1. Port forwarding 설정 (local:1024 -> Spider Server:1024)

  ssh -L 1024:localhost:1024 ubuntu@{spider_server_ip}
  

• 2. Swagger UI 활용한 Remote Spider API 호출/활용
  • (1) Spider Swagger UI 활용시
    • • Browser: http://localhost:1024/spider/api
    • • Browser: http://spider_server_ip:1024/spider/api
  • (2) Barista Swagger UI 활용시
    • • Browser: Barista Swagger UI

※ 참고: API별 개요 및 활용 가이드 제공

• User Guide, Concept Guide 등 API 관련된 Guide 제공
• 주로 자원 생성을 위한 Create API 문서에서 제공

[Swagger UI: API 관련 개요 및 활용 가이드 제공 예시]