CreateAPI 项目使用教程

CreateAPI 项目使用教程

CreateAPI Delightful code generator for OpenAPI specs 项目地址: https://gitcode.com/gh_mirrors/cr/CreateAPI

1. 项目目录结构及介绍

CreateAPI 项目的目录结构如下：

CreateAPI/
├── Docs/
├── Scripts/
├── Sourcery/
├── Sources/
├── Tests/
├── .gitattributes
├── .gitignore
├── sourcery.yml
├── swiftlint.yaml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── Package.resolved
├── Package.swift
├── README.md

目录介绍：

• Docs/: 包含项目的文档文件。
• Scripts/: 包含项目的脚本文件。
• Sourcery/: 包含 Sourcery 相关的配置和文件。
• Sources/: 包含项目的源代码文件。
• Tests/: 包含项目的测试代码文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• sourcery.yml: Sourcery 配置文件。
• swiftlint.yaml: SwiftLint 配置文件。
• CHANGELOG.md: 项目变更日志文件。
• CONTRIBUTING.md: 项目贡献指南文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目 Makefile 文件。
• Package.resolved: Swift 包管理器解析文件。
• Package.swift: Swift 包管理器配置文件。
• README.md: 项目介绍和使用说明文件。

2. 项目启动文件介绍

CreateAPI 项目的启动文件主要是 Package.swift 文件。该文件是 Swift 包管理器的配置文件，定义了项目的依赖关系、目标和产品。

Package.swift 文件内容示例：

// swift-tools-version:5.3
import PackageDescription

let package = Package(
    name: "CreateAPI",
    platforms: [
        .macOS(.v10_15),
        .iOS(.v13),
        .tvOS(.v13),
        .watchOS(.v6)
    ],
    products: [
        .library(name: "CreateAPI", targets: ["CreateAPI"]),
    ],
    dependencies: [
        .package(url: "https://github.com/OpenAPIKit/OpenAPIKit.git", from: "2.0.0"),
    ],
    targets: [
        .target(name: "CreateAPI", dependencies: ["OpenAPIKit"]),
        .testTarget(name: "CreateAPITests", dependencies: ["CreateAPI"]),
    ]
)

启动文件介绍：

• name: 定义项目的名称。
• platforms: 定义项目支持的平台。
• products: 定义项目的产品，即生成的库或可执行文件。
• dependencies: 定义项目的依赖包。
• targets: 定义项目的构建目标，包括主目标和测试目标。

3. 项目的配置文件介绍

CreateAPI 项目的主要配置文件包括 sourcery.yml 和 swiftlint.yaml。

sourcery.yml 文件内容示例：

templates:
  - ./Sourcery/Templates
output:
  ./Sources/Generated
args:
  config: ./Sourcery/Config

swiftlint.yaml 文件内容示例：

disabled_rules:
  - force_cast
  - force_try
opt_in_rules:
  - empty_count
  - vertical_whitespace_closing_braces
included:
  - Sources
excluded:
  - Carthage
  - Pods

配置文件介绍：

• sourcery.yml: 配置 Sourcery 代码生成工具的模板和输出路径。
• swiftlint.yaml: 配置 SwiftLint 代码风格检查工具的规则和忽略路径。

通过以上配置文件，可以自定义项目的代码生成和代码风格检查规则，确保项目代码的一致性和质量。

CreateAPI Delightful code generator for OpenAPI specs 项目地址: https://gitcode.com/gh_mirrors/cr/CreateAPI