Using the OpenAPI generator Gradle plugin

PublishedMarch 1, 2024

•3 min read•View as Markdown

Yong Shean

Google Developer Expert in Flutter & Dart 🚀| Mobile App Development 📱| Tech Advocate 🌐| Women Who Code KL Director

Comments

Join the discussion

No comments yet. Be the first to comment.

More from this blog

Riverpod from the Perspective of a Long-Term Bloc User

I've been using Bloc for years. It was my go-to state management solution, and I was comfortable with it. Events go in, states come out. Simple, predictable, testable. So when people kept telling me to try Riverpod, I resisted. Why fix what isn't bro...

Nov 2, 202511 min read

Flutter Performance: What Actually Makes a Difference

I've dealt with my share of performance issues in production Flutter apps. Janky scrolling that makes users think the app is broken. Memory leaks that crash the app after 10 minutes of use. The kind of problems that make you question your life choice...

Aug 8, 202512 min read

Flutter Architecture Patterns: Clean Architecture vs Feature-First

I've been building Flutter apps for a team of around 5 developers for the past few years. When I started, everyone talked about Clean Architecture like it was the only "professional" way to build apps. So naturally, I tried it. After months of writin...

Jun 8, 202513 min read

End-to-end testing on mobile apps with Maestro

Recently I talked about how to perform automated end-to-end testing on any mobile apps (yes, any, even those you don’t own) with Maestro.Deck: https://excalidraw.com/#json=YBaTDvWm8yTdshL8Z2IOL,7h7736K_Ey7wg08QljkbPg

May 16, 20251 min read

Asynchronous and reactive Dart (Flutter)

Recently I gave a talk at Google DevFest Georgetown 2024, about asynchronous Dart features (now with quizzes built in!). Here are the slides I promised:

Dec 16, 20241 min read

Yong Shean's dev notes

15 posts

Create build.gradle

If you don't have an existing build.gradle at the root of your project (not the build.gradle inside the android folder nor the one inside the android/app folder), create one. And then paste the following content:

plugins { id "org.openapi.generator" version "7.3.0" } openApiGenerate { // replace remoteInputSpec with inputSpec // if the api.yaml file is not remotely hosted remoteInputSpec.set(<url_to_api_yaml>) // The name of the generator which will handle codegen. generatorName = 'dart-dio' // The output target directory into which code will be generated. outputDir = "packages/backend_api" // Sets specified global properties. globalProperties = [ browserClient: 'false' hideGenerationTimestamp: 'true' ] // Defines whether or not model-related test files should be generated. generateModelTests = false // Defines whether or not api-related test files should be generated. generateApiTests = false // Defines whether or not model-related documentation files should be generated. generateModelDocumentation = false // Defines whether or not api-related documentation files should be generated. generateApiDocumentation = false // A map of options specific to a generator. // see https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/dart-dio.md#config-options // for the full set of available options configOptions = [ // Name in generated pubspec pubName: 'backend_api' ] // see https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc#openapigenerate // for the full set of available options }

Once this is saved, we can proceed to the final step - run it!

Alternative way if you don't want to use Gradle

If you have read through the above steps and you still can't wrap your head over the trouble of maintaining a Gradle file, it is worth mentioning that you can download the .jar binary directly and then execute in your terminal (you still need Java, of course):

#!/bin/bash java -jar openapi-generator-cli.jar generate \ -i ./api.yaml \ -g dart-dio \ -o ./packages/backend_api \ --additional-properties hideGenerationTimestamp=true,browserClient=false \ # other properties ...

Some people prefer using this way, so I just leave the option open, feel free to choose whichever option that suits you and your team.

Using the OpenAPI generator Gradle plugin

Comments

More from this blog

Riverpod from the Perspective of a Long-Term Bloc User

Flutter Performance: What Actually Makes a Difference

Flutter Architecture Patterns: Clean Architecture vs Feature-First

End-to-end testing on mobile apps with Maestro

Asynchronous and reactive Dart (Flutter)

Generate Gradle Wrapper

Create `build.gradle`

Run the OpenAPI generator

Alternative way if you don't want to use Gradle

Command Palette

Comments

More from this blog

Generate Gradle Wrapper

Create build.gradle

Run the OpenAPI generator

Alternative way if you don't want to use Gradle

Create `build.gradle`