Servant-Swagger 项目教程

Servant-Swagger 项目教程

servant-swaggerSwagger for Servant项目地址:https://gitcode.com/gh_mirrors/se/servant-swagger

1. 项目的目录结构及介绍

Servant-Swagger 项目的目录结构如下：

servant-swagger/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── Setup.hs
├── servant-swagger.cabal
├── src/
│   ├── Servant/
│   │   ├── Swagger.hs
│   │   ├── Swagger/
│   │   │   ├── Internal.hs
│   │   │   ├── Internal/
│   │   │   │   ├── Orphans.hs
│   │   │   │   ├── Test.hs
│   │   │   │   ├── TypeLevel.hs
│   │   │   │   ├── TypeLevel/
│   │   │   │   │   ├── API.hs
│   │   │   │   │   ├── Every.hs
│   │   │   │   │   ├── TMap.hs
│   │   │   ├── Test.hs
│   │   │   ├── TypeLevel.hs
│   ├── Servant/Swagger/Internal/
│   │   ├── Orphans.hs
│   │   ├── Test.hs
│   │   ├── TypeLevel.hs
│   │   ├── TypeLevel/
│   │   │   ├── API.hs
│   │   │   ├── Every.hs
│   │   │   ├── TMap.hs
│   ├── Servant/Swagger/Test.hs
│   ├── Servant/Swagger/TypeLevel.hs
├── stack.yaml
├── test/
│   ├── Spec.hs
│   ├── Test/
│   │   ├── Servant/
│   │   │   ├── Swagger.hs

目录结构介绍

• CHANGELOG.md: 记录项目的变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• Setup.hs: 项目设置文件。
• servant-swagger.cabal: Cabal 包描述文件。
• src/: 源代码目录。
  • Servant/: 主要模块目录。
    • Swagger.hs: 主模块文件。
    • Swagger/: 子模块目录。
      • Internal.hs: 内部模块文件。
      • Internal/: 内部子模块目录。
        • Orphans.hs: 孤立实例文件。
        • Test.hs: 测试模块文件。
        • TypeLevel.hs: 类型级别模块文件。
        • TypeLevel/: 类型级别子模块目录。
          • API.hs: API 类型级别文件。
          • Every.hs: 每个类型级别文件。
          • TMap.hs: 类型级别映射文件。
      • Test.hs: 测试模块文件。
      • TypeLevel.hs: 类型级别模块文件。
  • Servant/Swagger/Internal/: 内部模块目录。
    • Orphans.hs: 孤立实例文件。
    • Test.hs: 测试模块文件。
    • TypeLevel.hs: 类型级别模块文件。
    • TypeLevel/: 类型级别子模块目录。
      • API.hs: API 类型级别文件。
      • Every.hs: 每个类型级别文件。
      • TMap.hs: 类型级别映射文件。
  • Servant/Swagger/Test.hs: 测试模块文件。
  • Servant/Swagger/TypeLevel.hs: 类型级别模块文件。
• stack.yaml: Stack 配置文件。
• test/: 测试目录。
  • Spec.hs: 测试规范文件。
  • Test/: 测试子目录。
    • Servant/: 测试模块目录。
      • Swagger.hs: 测试模块文件。

2. 项目的启动文件介绍

项目的启动文件是 src/Servant/Swagger.hs。这个文件包含了生成 Swagger 规范的主要逻辑和接口。

启动文件介绍

• Swagger.hs: 主模块文件，定义了生成 Swagger 规范的接口和类型类。

3. 项目的配置文件介绍

项目的配置

servant-swaggerSwagger for Servant项目地址:https://gitcode.com/gh_mirrors/se/servant-swagger