Swagger Guide

[CB-Spider Swagger 정보]

• CB-Spider는 Swagger 기반의 REST API Documentation 제공

  • Swagger Documentations

    • https://github.com/cloud-barista/cb-spider/tree/master/api

  • Swagger UI: With Your Spider

    • http://localhost:1024/spider/api
    • http://server_ip:1024/spider/api

  • Swagger UI: Without Your Spider

    • https://cloud-barista.github.io/api?url=https://raw.githubusercontent.com/cloud-barista/cb-spider/master/api/swagger.yaml

[Swagger UI를 이용한 원격 Spider API 활용 Guide]

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

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

• (2) Browser: http://localhost:1024/spider/api

• (3) Browser(Swagger UI): Remote Spider API 활용

[참고: API 관련 개요 및 활용 가이드 제공]

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

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