2014-04-30 17 views
12

Jestem nowy w tych rzeczach, ale uwielbiam to. Zrobiłem trochę REST Api używając Slim Framework. Teraz chciałbym mieć bieżącą dokumentację na ten temat. Myślę, że wybredność jest właściwym wyborem, ale nie odkryłem jeszcze, jak to zintegrować?RESTful API Doc przy użyciu SLIM i SWAGGER?

Cheers & Dziękujemy za cierpliwość :)

+0

Słyszałem dobrą rzecz o Swagger - czy są jakieś dokumenty na powiązanej stronie? Myślę jednak, że ten temat jest zbyt szeroki - pamiętaj, że Stack Overflow służy do programowania problemów z kodem. Jeśli możesz to zrobić i edytować to pytanie na temat tego, na czym utkniesz, byłoby wspaniale. – halfer

+0

Nie wiem jak zintegrować SWAGGER w moim projekcie PHP. Oferują klienta php na Github i samouczek integracji serwera dla Javy, ale to nie zajęło mi więcej. W tej chwili nie mam pojęcia, jakie kroki muszę podjąć. Nie chcę umieszczać komentarzy w moim źródle, a następnie uruchomić narzędzie, które tworzy dokumentację. – user2942586

Odpowiedz

17

myślę szukasz tego projektu: zircote/swagger-php

Here przekonasz się jak generować doc na żądanie użytkownika do adresu URL.

Zasadniczo trzeba opisywać swój kod z Swagger adnotacje, a następnie utworzyć inną trasę w Slim z kodem podobnym do tego:

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

I będzie generować dokumenty Swagger API w locie dla Ciebie.

+0

dzięki! ale w jaki sposób mogę wtedy zintegrować ten interfejs ze swagger-UI? – user2942586

+0

uruchomiłem i uruchomiłem :) – user2942586

+0

@ user2942586 Czy byłbyś tak uprzejmy, aby wyjaśnić, jak to działa? – LeonardChallis

Powiązane problemy