Help Request - Dart examples

[joeblew99]

I am using goalng on server and dart on the client

I see that Swagger now has Dart client code gen support:
https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen/src/main/resources/dart

Does anyone happen to know any examples of this used in projects or more code samples where this is used ?

thanks in advance.
If there is a better place to ask this please let me know and i will close it here

[wing328]

@ircecho may I know if you've any sample codes/projects on using the Dart API client generated by Swagger Codegen?

It would be nice if the community can contribute the following:

1. add some integration tests for Dart API client,
2. add auto-generated documentation to Dart API client.

[ircecho]

Unfortunately, we do not have any publicly available code samples. And it would not be very interesting for this context either. Our API calls are pretty straightforward. For example:

  defaultApiClient.basePath = 'http://localhost:8081/backend';
  final JwtHttpClient client = new JwtHttpClient();
  defaultApiClient.client = client;

  final String username = [...];
  final String password = [...];

  final LoginApi loginController = new LoginApi();
  final Credentials userToken = await loginController.login(new LoginData()
    ..email = username
    ..password = password);
  client.jwt = userToken.jwToken;
  Credentials merchantToken = await loginController.escalateToSellerAdmin(68);
  client.jwt = merchantToken.jwToken;

And so on. As you can see, we are doing nothing out of the ordinary.

[joeblew99]

thanks for response.

I think it would be really useful for others for examples that consume the output of the code gen to be in the repo.

So, shall i leave this open ?

[wing328]

@ircecho @joeblew99 if you guys have cycle, I can work with you to automatically generate the documentation for endpoints and models in the Dart API client, similar to what we've done for other languages: e.g. https://github.com/wing328/test-php/blob/master/docs/Api/PetApi.md#addpet

[ircecho]

@wing328 What would you need?

[wing328]

@ircecho as a starting point, I need to know which language (C#, Java, PHP, Ruby, etc) is similar to Dart so that we can borrow the documentation templates from other language to start with.

[wing328]

@ircecho here is the doc I've come up with: https://github.com/wing328/swagger-codegen/blob/dart_add_doc/samples/client/petstore/dart/swagger/README.md

Please review to see if it looks good from your perspective

Disclaimer: I'm no expert in Dart

[wing328]

PR: #4291

[ircecho]

The import statements need to be changed. Only the following is necessary:

import 'package:pet_store/api.dart';

The name pet_store depends on how the library is named, which is up to the user. You will know what is the correct value in this case.

Furthermore, it should be noted that it is necessary to include the library in the pubspec.yaml file and (dart buffs will know that already) run pub get afterwards. We are using a github reference and there are other ways, for instance including it from a local folder.

name: PetStoreExample
version: 0.0.1
description: A simple console application.
dependencies:
  pet_store:
    git: https://github.com/somethingsomething/pet_store.git
    version: 'any'

[wing328]

How's pet_store determined? Is it the pubName? I only found the following option for Dart client at the moment:

CONFIG OPTIONS
	sortParamsByRequiredFlag
	    Sort method arguments to place required parameters before optional parameters. (Default: true)

	ensureUniqueParams
	    Whether to ensure parameter names are unique in an operation (rename parameters that are not). (Default: true)

	browserClient
	    Is the client browser based

	pubName
	    Name in generated pubspec

	pubVersion
	    Version in generated pubspec

	pubDescription
	    Description in generated pubspec

	sourceFolder
	    source folder for generated code

Furthermore, it should be noted that it is necessary to include the library in the pubspec.yaml file

I'll update the installation instruction with that

Can you also show how to include it from a local folder as well?

[ircecho]

Yes. The three values have to be the same: pubName, the name used in pubspec.yaml and the name used in the import.

The pubspec would look like this:

dependencies:
  pet_store:
    path: /Users/me/pet_store

A full treatise on dependencies can be found here: https://www.dartlang.org/tools/pub/dependencies Dart users will already have some superficial knowledge about that.

[wing328]

Updated: https://github.com/wing328/swagger-codegen/blob/dart_add_doc/samples/client/petstore/dart/swagger/README.md

Please take another look.

Can you also help review the sample code for authentication (HTTP basic, API key, OAuth)? https://github.com/wing328/swagger-codegen/blob/dart_add_doc/modules/swagger-codegen/src/main/resources/dart/api_doc.mustache#L31-L45