SLIM 및 SWAGGER를 사용하는 RESTful API Doc?

나는 이것들에 처음이지만 사랑한다. 슬림 프레임 워크를 사용하여 약간의 REST API를 만들었습니다. 이제는 그것에 관한 지속적인 문서화를 원합니다. 나는 비틀 거림이 올바른 선택이라고 생각하지만, 아직 그것을 통합하는 방법을 찾지 못했습니까?SLIM 및 SWAGGER를 사용하는 RESTful API Doc?

건배 양해 :)

출처

2014-04-30 user2942586

나는 Swagger에 대해 좋은 말을 들었습니다. 관련 웹 사이트에 문서가 있습니까? 그러나, 내 생각 엔이 주제는 너무 광범위합니다 - 스택 오버플로는 코드 관련 프로그래밍 문제를 염두에 두어야합니다. 네가 붙어있는 것에 대해이 질문을 편집 해 편집 할 수 있다면, 좋을 것이다. – halfer

내 PHP 프로젝트에서 swagger를 통합하는 방법을 모른다. 그들은 Github에서 PHP 클라이언트를 제공하고 Java에 대한 서버 통합 자습서를 제공하지만이 사실은 나에게 더 이상 걸리지 않습니다. 지금 나는 어떤 조치를 취해야하는지 전혀 모른다. 나는 내 소스에 주석을 달고 문서를 만드는 도구를 실행하고 싶지 않습니다. – user2942586

에 대한 & 덕분에 나는이 프로젝트를 찾고 있습니다 생각 : zircote/swagger-php

Here 당신이 URL에 대한 사용자 요청에 문서를 생성하는 방법을 찾을 수 있습니다.

은 기본적으로는 다음이 유사한 코드로 슬림 다른 경로를 만듭니다 자신감 주석과 코드에 주석이 있습니다

<?php 
use Swagger\Swagger; 
$swagger = new Swagger('/project/root/top_level'); 
header("Content-Type: application/json") 
echo $swagger->getResource('/pet', array('output' => 'json'));

을 그리고 그것은 당신을 위해 즉석에서 자신감의 API 문서를 생성합니다.

출처

2014-04-30 21:14:31 adosaiguas

감사합니다! 그런데 어떻게 그 멋진 UI를 통합 할 수 있을까요? – user2942586

실행 해보세요 :) – user2942586

@ user2942586 어떻게 당신이 그것을 어떻게 운영하는지 설명 할만큼 친절하십니까? – LeonardChallis

SLIM 및 SWAGGER를 사용하는 RESTful API Doc?

답변

관련 문제