套件詳情v4.1.1

swagger_dart_code_generator

你是否在撰寫 HTTP 請求程式碼時遇到問題？這個套件可以幫上忙。它具有你一直尋找的所有 HTTP 和模型程式碼產生功能。

AndroidiOSWebmacOSWindowsLinux

pub.dev API 文件原始碼

近 30 天下載: 6.7萬
喜歡數: 335
Pub 分數: 145

安裝套件

flutter pub add swagger_dart_code_generator

套件介紹

根據套件公開資料產生的選型評估，僅供參考。

一個 Flutter/Dart 套件，可從 OpenAPI/Swagger 規範產生 HTTP 客戶端程式碼與資料模型。它自動化建立類型安全的 API 客戶端，減少重複程式碼並最小化網路請求中的錯誤。適合使用 Swagger 或 OpenAPI 定義的 RESTful API 的開發者，透過產生乾淨、易維護的 Dart 程式碼來簡化整合。此產生器支援多個平台，包含 Android、iOS、Web、macOS、Windows 及 Linux。

適用情境

從 OpenAPI 規範自動產生 API 客戶端
減少手動 HTTP 請求程式碼
使用類型安全整合 REST API
從 JSON 架構生成模型
簡化Flutter應用中的後端整合

主要特色

從 OpenAPI 2.0 和 3.0 規範生成 HTTP 客戶端
產生類型安全的 Dart 模型
支援自訂標頭和驗證
提供可配置的輸出結構
與 Flutter 构建系統整合

適合對象

使用 OpenAPI 定義的 API 的 Flutter 團隊
尋求減少 API 集成時間的開發人員
需要一致且可重用的 API 客戶端的專案
注重程式碼品質和可維護性的團隊

使用建議

需要有效的 OpenAPI/Swagger 規範
當 API 發生變更時需要手動更新
僅限靜態代碼生成（無執行時靈活性）
最佳搭配版本控制的 API 規範使用
可能需要為複雜端點進行額外設定

原始 README

以下為關聯原始碼儲存庫的 README 原文快照，最新內容請造訪原始碼儲存庫。

:mega: Build dart types from Swagger/OpenAPI schemas :mega:

SwaggerDartCodeGenerator is a code generator that looks for *.swagger files and builds .swagger.dart files, based on the schema. Code generation based on Chopper and JsonAnnotation models and can be configured for your needs.

Overview

In general case for each .swagger file three outputs will be created.
.dart generated by Swagger dart code generator, contains all models, requests, converters, etc.
[Since v1.2.0] .enums.dart generated by Swagger dart code generator, contains all enums and enums mappings.
.chopper.dart - generated by chopper.
.g.dart - generated by json_serializable.

Installation

The generated code uses the following packages in run-time:

dependencies:
  chopper: ^8.0.3
  json_annotation: ^4.9.0

Add the following to your pubspec.yaml file to be able to do code generation:

dev_dependencies:
  build_runner: ^2.4.9
  chopper_generator: ^8.0.3
  json_serializable: ^6.8.0
  swagger_dart_code_generator: ^3.0.1

Then run:

dart pub get

flutter pub get

Now SwaggerGenerator will generate the API files for you by running:

dart run build_runner build

Configuration

Swagger generator offers some configuration options to generate code. All options should be included on build.yaml file on the root of the project:

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          # custom configuration options!

Option	Default value	Is required	Description
`input_folder`	`-`	`true`	Path to folder with .swagger files (for ex. swagger_examples, or lib/swaggers).
`output_folder`	`-`	`true`	Path to output folder (for ex. lib/generated).
`input_urls`	`[]`	`false`	Here you can mention list of files to be downloaded from the internet. You can check example of usage.
`with_base_url`	`true`	`false`	If this option is false, generator will ignore base url in swagger file.
`use_required_attribute_for_headers`	`true`	`false`	If this option is false, generator will not add @required attribute to headers.
`with_converter`	`true`	`false`	If option is true, combination of all mappings will be generated.
`ignore_headers`	`false`	`false`	If option is true, headers will not be generated.
`additional_headers`	`false`	`false`	List of additional headers, not specified in Swagger. Example of usage: build.yaml
`enums_case_sensitive`	`true`	`false`	If value is false, 'enumValue' will be defined like Enum.enumValue even it's json key equals 'ENUMVALUE'
`include_paths`	`[]`	`false`	List of Regex If not empty - includes only paths matching reges
`exclude_paths`	`[]`	`false`	List of Regex If not empty -exclude paths matching reges
`classes_with_nullabe_lists`	[]	`false`	List of regex strings. If class name matches any of regex - list properties will have default value `null`. Otherwise it will be empty list. If you used `use_default_null_for_lists: true`, just set `.*` value for this property and result will be same. Check example for more details
`build_only_models`	`false`	`false`	If option is true, chopper classes will not be generated.
`separate_models`	`false`	`false`	If option true, generates models into separate file.
`include_if_null`	`null`	`false`	Sets includeIfNull JsonAnnotation feature and sets value for it. If null - not set anything.
`default_values_map`	`[]`	`false`	Contains map of types and theirs default values. See DefaultValueMap.
`response_override_value_map`	`[]`	`false`	Contains map of responses and theirs overridden values. See ResponseOverrideValueMap.
`cut_from_model_names`	`-`	`false`	If your model names are long and contain a lot of duplicated words, for example `DbUsersModelsV3GeneralUserModel`, you can cut off duplicated part, using `cut_from_model_names : DbUsersModelsV3`. Also, you can use regex expressions in this parameter.
`nullable_models`	`-`	`false`	List of model names should have force-nullable properties. Example of usage in build.yaml.
`override_equals_and_hashcode`	`-`	`true`	If need to decrease app size - you can disable generation of `hashcode` and `Equals` method.
`overriden_models`	`-`	`false`	List of manually written models that will replace the generated one. Can be different for each file. See example here
`use_path_for_request_names`	`true`	`false`	Can be false only if all requests has unique `operationId`. It gives readable names for requests.
`add_base_path_to_requests`	`false`	`false`	Add swagger base path to all request path.
`multipart_file_type`	`List<int>`	`false`	Allow to override the generated class for multipart file (See #605).
`override_to_string`	`bool`	`true`	Overrides `toString()` method using `jsonEncode(this)`
`generate_first_succeed_response`	`true`	`false`	If request has multiple success responses, first one will be generated. Otherwice - `dynamic`
`multipart_file_type`	`List<int>`	`false`	Type if input parameter of Multipart request
`scalars`	`-`	`{}`	A map of custom types that are used for string properties with a given format. See example here

It's important to remember that, by default, build will follow Dart's package layout conventions, meaning that only some folders will be considered to parse the input files. So, if you want to reference files from a folder other than lib/, make sure you've included it on sources:

targets:
  $default:
    sources:
      - lib/**
      - swagger_examples/**
      - swaggers/**

Default Value Map for model generation

If you want to add defaultValue: attribute to fields with concrete type you can use default value map. Please see next example:

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          input_folder: 'lib/swaggers'
          output_folder: 'lib/generated_code/'
          default_values_map:
            - type_name: int
              default_value: '36'
            - type_name: String
              default_value: 'default'
            - type_name: 'List<String>'
              default_value: '[]'
          exclude_paths:
            - '\/cars\/get'
          include_paths:
            - '\/popular\/cars'

Overriden Models Implementation

      swagger_dart_code_generator:
        options:
          input_folder: "input_folder/"
          output_folder: "lib/swagger_generated_code/"
          overriden_models:
            - file_name: "pet_service_json"
              import_url: "../overriden_models.dart"
              overriden_models:
                - "Pet"
                - "Order"
            - file_name: "pet_service_swagger"
              import_url: "../overriden_models_another.dart"
              overriden_models:
                - "Result"

Scalars Implementation

      swagger_dart_code_generator:
        options:
          input_folder: "input_folder/"
          output_folder: "lib/swagger_generated_code/"
          import_paths:
            - "package:uuid/uuid.dart"
          scalars:
            uuid:
              type: Uuid
              deserialize: Uuid.parse
              # optional - default is toString()
              serialize: myCustomUuidSerializeFunction

Response Override Value Map for requests generation

If you want to override response for concrete request, you can use response_override_value_map. For example:

targets:
  $default:
    builders:
      swagger_dart_code_generator:
        options:
          input_folder: 'lib/swaggers'
          output_folder: 'lib/generated_code/'
          response_override_value_map:
            - url: '/store/inventory'
              method: get
              overridden_value: 'List<dynamic>'
            - url: '/news/latest'
              method: put
              overridden_value: 'MyPerfectType'

Check the examples to see how to use it in details.

所屬分類

OpenAPI & Swagger

依賴

依賴清單 11 項

build^4.0.2
code_builder^4.11.0
collection^1.19.1
dart_style^3.1.2
http^1.5.0
json_annotation^4.9.0
markdown^7.3.0
path^1.9.1
recase^4.1.0
universal_io^2.2.2
yaml^3.1.3

原始碼儲存庫

epam-cross-platform-lab/swagger-dart-code-generator