我使用过Markdown,Wiki管理接口文档,过程实在难以称得上美好,工作量巨大并且十分无趣。接口的变更需要维护相关文档;接口无法方便地进行调试、测试;以及接口的管理完全依赖于人。这些问题不仅导致接口文档难以维持很高的质量,而且还会让开发人员花费更多的时间在接口调试上,甚至影响项目进度。最最最重要的是,这可能会影响到我们的心情,这可是无法忍受的事情 : ( 。
主要思想:基于OpenAPI规范,使用Json Schema校验参数,通过Swagger-UI提供优美的API管理界面。
特性
- 内置Swagger-UI,方便查看、调试接口
- 使用OpenAPI/Swagger API文档自动生成Koa路由,并支持参数校验
- 支持OpenAPI/Swagger2.0规范,支持json、yaml格式
- 支持基于JsonSchema V4的接口query、body、path、header参数校验
- 支持自定义JsonSchema format校验
- 支持自定义接口错误处理
这不仅仅是一个Router,我希望可以为大家提供一种思路。通过此了解到更多的规范、协议以及工具,一起优化、完善一件可能对未来软件开发效率有那么一点点提高的事情。
代码丑陋,可能有BUG、用法不人性、性能低、不规范和任何使用问题,欢迎issue或者PR。 喜欢的话记得Star哦!
传送门:koa-oai-router
注意:目前仍然处于测试阶段,生产环境谨慎使用!!!