openapi_code_builder 1.3.2 openapi_code_builder: ^1.3.2 copied to clipboard
Generate Dtos, client and server scaffolds for openapi specs.
Dart OpenApi Code Generator #
openapi_code_builder
generates server stubs and client libraries for open api schema yaml files.
This is a build_runner
library meant to be included in the
dev_dependencies
of your project to allow generating of
dart source files for client and server stubs for
OpenAPI 3.0 schema files (Only yaml is supported right now).
See directory for an example usage.
You can also try out the code generator right inside your browser: https://hpoul.github.io/openapi_dart/
Real world example #
See the backend for AuthPass which uses auto generated openapi basically as http server. Yaml file available on github.
Usage #
- Update
pubspec.yaml
:dependencies: json_annotation: ^3.0.1 openapi_base: any dev_dependencies: openapi_code_builder: any json_serializable: ^3.3.0 build_runner: ^1.10.0
- Create your schema file into your
lib
folder with the extension.openapi.yaml
- Optional: Add the base name to your schema
openapi: 3.0.0 info: x-dart-name: MyApiName
- Run the build_runner:
(flutter) pub run build_runner build --delete-conflicting-outputs
- Implement the server and client. (see below)
Example schema #
openapi: 3.0.0
info:
version: 0.1.0
title: Example API
x-dart-name: TestApi
paths:
/hello/{name}:
parameters:
- name: name
in: path
required: true
schema:
type: string
get:
summary: Say Hello World to {name}
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/HelloResponse'
components:
schemas:
HelloResponse:
properties:
message:
type: string
description: 'The Hello World greeting ;-)'
Implement Server #
class TestApiImpl extends TestApi {
@override
Future<HelloNameGetResponse> helloNameGet({String name}) async {
_logger.info('Saying hi to $name');
return HelloNameGetResponse.response200(
HelloResponse(message: 'Hello $name'));
}
}
Create a server and bind it to a port #
Future<void> main() async {
PrintAppender.setupLogging();
_logger.fine('Starting Server ...');
final server = OpenApiShelfServer(
TestApiRouter(ApiEndpointProvider.static(TestApiImpl())),
);
server.startServer();
}
Implement Client #
Future<void> main() async {
final requestSender = HttpRequestSender();
final client = TestApiClient(
Uri.parse('http://localhost:8000'),
requestSender);
final blubb = await client.helloNameGet(name: 'Blubb');
blubb.map(
on200: (response) => _logger.info('Success: ****${response.body.message}'),
);
_logger.info('Response: $blubb');
requestSender.dispose();
}
Try it out #
Run in openapi_dart/packages/openapi_code_builder/example
Server #
dart run bin/example_server.dart
Client #
dart run bin/example_client.dart