0

現在、プロジェクトのために、Swagger を使用してドキュメントを作成する必要があります。プロジェクトは php で行われるため、Swagger-Php を使用してコードに注釈を付け、ドキュメントを作成します。ここで、すべてのサンプル プロジェクトがオブジェクト指向であることに気付きました。つまり、リクエストが行われると、コントローラーが呼び出され、モデルなどが呼び出されます。私が参加しているプロジェクトでは、プロジェクトはこのように編成されていません。各ページには独自のファイルがあります。 、そのファイル内のすべての操作を処理します。このように Swagger を使用してコードを文書化するにはどうすればよいでしょうか?

たとえば、次の疑似コードは、基本的に各ファイルが行うことです。

<?php
    //get paramters
    //query database
    //return json file, either data or status of the operation
?>

私はこのようなことをしますか?

<?php
    /*
     * @SWG\Resource(
     * apiVersion="1.0",
     * basePath="http://url.com/exampleFile"
     * )
     * */
    /* @SWG\Api(
     * @SWG\Operation(
     * summary="Retreives data from database and prints out in json",
     * method="GET",
     * type="", // what would go here?
     * @SWG\Parameter(name="param1",type="string"),
     * @SWG\Parameter(name="param2",type="int")
     * )
     * )
     * */
     //How will I show example of json to be printed to the user?

    //get paramters
    //query database
    //return json file, either data or status of the operation
?>

助けてくれてありがとう。

4

1 に答える 1