morapt/changelog

简单的Changelog CRUD API，用于存储Markdown并将其解析为HTML输出

维护者

详细信息

github.com/morsapt/changelog

源代码

问题

安装: 42

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

公开问题: 0

1.0.2 2023-03-24 12:27 UTC

Requires

MIT a72b62f9b26f0c467ddd46f5132140d2aecc53f0

  • Mario Rodrigues <morsa.h.woop@gmail.com>

This package is auto-updated.

Last update: 2024-09-24 15:56:01 UTC

README

这是一个简单的CRUD，用于在数据库中维护变更日志Markdown条目，并将其输出为HTML代码。

免责声明

这是我为Laravel制作的第一个包，可能有些功能缺失或不完整。请谅解。如果您喜欢，请随意贡献。我制作这个包是因为我需要维护用户了解新版本细节。这仅用于内部使用。

安装

  1. 使用composer安装此包。
composer require morsapt/changelog
  1. 运行迁移
php artisan migrate

这将创建一个带有mpt_前缀的变更日志表 - mpt_changelogs

端点

  • GET /changelogs - 返回所有变更日志条目
  • GET /changelogs/{changelog_id} - 根据其PK（id）返回特定的变更日志条目
  • POST /changelogs - 创建一个变更日志条目
  • PUT /changelogs/{changelog_id} - 更新一个变更日志条目
  • DELETE /changelogs/{changelog_id} - 删除一个变更日志条目

排序和限制

默认情况下，GET /changelogs端点使用分页，并将根据perPage和orderBy参数进行分页。

  • perPage - 设置每页返回的项目数量
    • 项目数量的最大值设置为500
    • 它只接受整数值；如果值无效，则将设置为仅10个项目。
  • orderBy - 参数数组
    • 参数的顺序将改变查询的排序顺序
    • 允许的值：ASC和DESC
  • page - 页码（来自Laravel分页）

GET示例

https://my.tld/api/changelogs?perPage=50orderBy[changelog]=ASC&orderBy[id]=DESC

这将为您返回每页50个项目，按changelog列升序和id列降序排序。