简介

Katana Model OpenAPI Adapter 是一个用于 Flutter 的插件，它可以帮助开发者根据 OpenAPI 规范自动生成数据模型。通过该插件，你可以轻松地将 API 响应映射到 Dart 类，并进行类型检查。

安装

在 pubspec.yaml 文件中添加依赖：

dependencies:
  katana_model_openapi_builder: ^1.0.0

然后运行以下命令以安装依赖：

flutter pub get

使用

1. 配置 OpenAPI 规范

首先，你需要准备一个 OpenAPI 规范文件（例如 openapi.yaml 或 openapi.json），该文件描述了你的 API 接口。

2. 生成模型

使用 katana_model_openapi_builder 插件生成模型。你可以在 build.yaml 文件中配置生成器：

targets:
  $default:
    builders:
      katana_model_openapi_builder:
        options:
          openapi_file: "lib/openapi.yaml"
          output_directory: "lib/models"

3. 运行构建

运行以下命令以生成模型：

flutter packages pub run build_runner build

4. 使用生成的模型

生成的模型将被放置在 lib/models 目录下。你可以直接导入这些模型并在你的项目中使用它们。

示例代码

假设你有一个 OpenAPI 规范文件 openapi.yaml，其中包含以下内容：

openapi: 3.0.0
info:
  title: Sample API
  version: 1.0.0
paths:
  /users:
    get:
      responses:
        '200':
          description: A list of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        email:
          type: string

运行上述步骤后，生成的 User 模型将位于 lib/models/user.dart 文件中：

// lib/models/user.dart
class User {
  final int id;
  final String name;
  final String email;

  User({
    required this.id,
    required this.name,
    required this.email,
  });

  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      id: json['id'] as int,
      name: json['name'] as String,
      email: json['email'] as String,
    );
  }

  Map<String, dynamic> toJson() => {
        'id': id,
        'name': name,
        'email': email,
      };
}

现在，你可以使用 User 模型来解析 API 响应：

import 'package:http/http.dart' as http;
import 'package:your_project/models/user.dart';

Future<List<User>> fetchUsers() async {
  final response = await http.get(Uri.parse('http://example.com/users'));

  if (response.statusCode == 200) {
    List<dynamic> body = jsonDecode(response.body);
    return body.map((dynamic item) => User.fromJson(item)).toList();
  } else {
    throw Exception('Failed to load users');
  }
}

通过这种方式，你可以轻松地管理和使用从 API 获取的数据。