web-dev-qa-db-ja.com

SLIMとSWAGGERを使用したRESTful APIドキュメント?

私はこれについては初めてですが、大好きです。私は少しREST Slim Frameworkを使用してAPIを作成しました。次に、それについて継続的なドキュメントを作成したいと思います。swaggerが正しい選択だと思いますが、それを統合する方法はまだわかりません。 ?

お待ちいただき、ありがとうございます。

17
user2942586

私はあなたがこのプロジェクトを探していると思います: zircote/swagger-php

ここ URLへのユーザーリクエストでドキュメントを生成する方法を説明します。

基本的には、Swaggerアノテーションを使用してコードに注釈を付け、次に次のようなコードを使用してSlimに別のルートを作成する必要があります。

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

そして、その場でSwagger APIドキュメントを生成します。

23
adosaiguas