refactored lib

Author: gibahjoe

CHANGELOG.md

@@ -1,3 +1,3 @@
 ## 1.0.0
 
-- Initial version, created by Stagehand
+- Initial version

LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Joseph Gibah
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
+conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived
+from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

example/.gitignore

@@ -188,3 +188,5 @@ fabric.properties
 
 # Android studio 3.1+ serialized cache file
 .idea/caches/build_file_checksums.ser
+!/api/petstore_api/pubspec.yaml
+api/

example/api/petstore_api/.gitignore

@@ -1,9 +1,6 @@
 import 'package:flutter/material.dart';
-
 import 'package:petstore_api/api.dart';
-import 'package:petstore_api/api/pet_api.dart';
 import 'package:petstore_api/api/store_api.dart';
-import 'package:provider/provider.dart';
 
 void main() => runApp(MyApp());
 

example/api/petstore_api/.openapi-generator-ignore

@@ -1,11 +1,10 @@
-import 'package:flutter/material.dart';
-import 'package:meta/meta.dart';
 import 'package:openapi_generator_annotations/openapi_generator_annotations.dart';
 
 @Openapi(
     additionalProperties:
-        AdditionalProperties(pubName: 'petstore_api', pubAuthor: 'Johnny dep'),
+    AdditionalProperties(pubName: 'petstore_api', pubAuthor: 'Johnny depp'),
     inputSpecFile: 'spec/openapi-spec.yaml',
     generatorName: 'dart-jaguar',
     outputDirectory: 'api/petstore_api')
-class OpenapiConfig extends OpenapiGeneratorConfig {}
+class OpenapiConfig extends OpenapiGeneratorConfig {
+}

example/api/petstore_api/.travis.yml

@@ -19,7 +19,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  openapi_generator_annotations: ^0.0.2-dev
+  openapi_generator_annotations: ^1.0.2
   petstore_api:
     path: api/petstore_api
   provider: ^4.0.4
@@ -33,8 +33,7 @@ dev_dependencies:
   flutter_test:
     sdk: flutter
   build_runner: ^1.7.4
-  openapi_generator:
-    path: ../openapi-generator
+  openapi_generator: ^0.1.2
 
 
 # For information on the generic Dart part of this file, see the

example/api/petstore_api/README.md

@@ -1,3 +1,7 @@
+## 1.0.2
+
+- Updated documentation
+
 ## 0.0.2-dev
 
 - Changed version to dev since this package is still in active development

example/api/petstore_api/analysis_options.yaml

@@ -1,11 +1,27 @@
 Annotation library for dart/flutter implementation of openapi client code generation.
+To be used together with [openapi-generator](https://pub.dev/packages/openapi_generator)
 
-Created from templates made available by Stagehand under a BSD-style
-[license](https://github.com/dart-lang/stagehand/blob/master/LICENSE).
+[license](https://github.com/gibahjoe/openapi-generator-dart/blob/master/openapi-generator-annotations/LICENSE).
 
 ## Usage
 
-A simple usage example:
+Include [openapi-generator-annotations](https://pub.dev/packages/openapi_generator_annotations) as a dependency in the dependencies section of your pubspec.yaml file :
+
+```yaml
+dependencies:
+  openapi_generator_annotations: ^1.0.0
+```
+
+
+Add [openapi-generator](https://pub.dev/packages/openapi_generator) in the dev dependencies section of your pubspec.yaml file:
+
+```yaml
+dev_dependencies:
+  openapi_generator: ^0.0.2-beta
+```
+
+
+Annotate a dart class with @Openapi() annotation
 
 ```dart
 @Openapi(
@@ -17,6 +33,13 @@ A simple usage example:
 class Example extends OpenapiGeneratorConfig {}
 ```
 
+Run command below to generate open api client sdk from spec file specified in annotation. 
+```cmd
+flutter pub run build_runner build --delete-conflicting-outputs
+```
+
+The api sdk will be generated in the folder specified in the annotation. See examples for more details
+
 ## Features and bugs
 
 Please file feature requests and bugs at the [issue tracker][tracker].