README

BRJ组织

结构化API文档

完全自动化的文档工具。

📦 安装

最好使用Composer进行安装，您也可以在Packagist和GitHub上找到此包。

要安装，只需使用以下命令

$ composer require baraja-core/structured-api-doc

您可以通过创建内部类的实例手动使用此包，或者注册DIC扩展将服务直接链接到Nette框架。

理念

在开发任何应用程序时，开发者必须维护源代码本身以及描述其他功能的文档。在单独的系统上编写文档会花费更多时间，容易出错，并且随着时间的推移，文档会过时。BRJ通过允许开发者直接在源代码的注释中编写文档，然后始终一致地生成页面，从而解决这个问题。

如何开始使用BRJ文档？

将结构化API端点（实现Baraja 结构化API）添加到您的应用程序中
安装此包
打开URL /api-documentation

具有原生注释的示例端点实现

/**
 * Common API endpoint for robust article manipulation.
 *
 * @endpointName Article manager
 */
final class ArticleEndpoint extends BaseEndpoint
{
   #[Inject]
   public ArticleManagerAccessor $articleManager;


   /**
    * @param string $locale in format "cs" or "en"
    * @param int $page real page number for filtering, 1 => first page ... "n" page
    * @param string|null $filterTitle filter by words in title?
    * @param string|null $filterFrom find all articles from this date
    * @param string|null $filterTo find all articles to this date
    */
   public function actionDefault(string $locale, int $page = 1, ?string $filterTitle = null, ?string $filterFrom = null, ?string $filterTo = null): void
   {
      // Here is some body...

为开发者设计

我们了解在PHP和前端维护数据结构可能会很具挑战性，因此该库包括一个原生按钮，可以将任何响应结构导出到TypeScript

📄 许可证

baraja-core/structured-api-doc采用MIT许可证。有关详细信息，请参阅LICENSE文件。

baraja-core / structured-api-doc

维护者

详细信息

README

结构化API文档

📦 安装

理念

为开发者设计

📄 许可证