using aep-lib-go's generation logic

Author: toumorokoshi

cmd/root.go

@@ -22,8 +22,6 @@ import (
 
 	"github.com/ghodss/yaml"
 
-	"encoding/json"
-
 	"github.com/aep-dev/aep-lib-go/pkg/api"
 	"github.com/aep-dev/aep-lib-go/pkg/proto"
 	"github.com/aep-dev/aepc/validator"
@@ -52,22 +50,21 @@ func NewCommand() *cobra.Command {
 
 func ProcessInput(inputFile, outputFilePrefix string) error {
 	outputDir := filepath.Dir(outputFilePrefix)
-	var a api.API
 	input, err := ReadFile(inputFile)
 	fmt.Printf("input: %s\n", string(input))
 	if err != nil {
 		return fmt.Errorf("unable to read file: %w", err)
 	}
 	ext := filepath.Ext(inputFile)
-	err = unmarshal(ext, input, &a)
+	a, err := deserializeAPI(ext, input)
 	if err != nil {
 		return fmt.Errorf("unable to unmarshal file: %w", err)
 	}
-	errors := validator.ValidateAPI(&a)
+	errors := validator.ValidateAPI(a)
 	if len(errors) > 0 {
 		return fmt.Errorf("error validating service: %v", errors)
 	}
-	proto, err := proto.APIToProtoString(&a, outputDir)
+	proto, err := proto.APIToProtoString(a, outputDir)
 	if err != nil {
 		return fmt.Errorf("error writing service proto: %w", err)
 	}
@@ -100,24 +97,27 @@ func ProcessInput(inputFile, outputFilePrefix string) error {
 	return nil
 }
 
-func unmarshal(ext string, b []byte, a *api.API) error {
+func deserializeAPI(ext string, b []byte) (*api.API, error) {
 	switch ext {
 	case ".yaml":
 		asJson, err := yaml.YAMLToJSON(b)
 		if err != nil {
-			return fmt.Errorf("unable to decode yaml to JSON %q: %w", string(b), err)
+			return nil, fmt.Errorf("unable to decode yaml to JSON %q: %w", string(b), err)
 		}
-		if err := json.Unmarshal(asJson, a); err != nil {
-			log.Fatal(fmt.Errorf("unable to decode proto %q: %w", string(b), err))
+		api, err := api.LoadAPIFromJson(asJson)
+		if err != nil {
+			log.Fatal(fmt.Errorf("unable to unmarshal json %q: %w", string(b), err))
 		}
+		return api, nil
 	case ".json":
-		if err := json.Unmarshal(b, a); err != nil {
-			return fmt.Errorf("unable to decode json %q: %w", string(b), err)
+		api, err := api.LoadAPIFromJson(b)
+		if err != nil {
+			log.Fatal(fmt.Errorf("unable to unmarshal json %q: %w", string(b), err))
 		}
+		return api, nil
 	default:
-		return fmt.Errorf("extension %v is unsupported", ext)
+		return nil, fmt.Errorf("extension %v is unsupported", ext)
 	}
-	return nil
 }
 
 func ReadFile(fileName string) ([]byte, error) {

example/bookstore/v1/bookstore.pb.go

@@ -69,8 +69,10 @@ service Bookstore {
     };
   }
 
-  // archive abook.
-  rpc archiveBook ( ArchiveBookRequest ) returns ( aep.api.Operation ) {
+  // archive a book.
+  rpc ArchiveBook ( ArchiveBookRequest ) returns ( aep.api.Operation ) {
+    option (aep.api.operation_info) = { response_type: "example.bookstore.v1.ArchiveBookResponse" };
+
     option (google.api.http) = {
       post: "/{path=publishers/*/books/*}:archive",
       body: "*"
@@ -193,20 +195,20 @@ message Book {
     string lastName = 2;
   }
 
-  // Field for author.
-  repeated Author author = 5;
-
   // Field for isbn.
   repeated string isbn = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Field for price.
-  float price = 2 [(google.api.field_behavior) = REQUIRED];
+  int32 price = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Field for published.
   bool published = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Field for edition.
-  int32 edition = 4;
+  int32 edition = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Field for author.
+  repeated Author author = 5 [(google.api.field_behavior) = REQUIRED];
 
   // Field for path.
   string path = 10018;
@@ -360,8 +362,6 @@ message ArchiveBookRequest {
 
 // Response message for the archive method
 message ArchiveBookResponse {
-  // Field for success.
-  bool success = 1;
 }
 
 // A Create request for a  book-edition resource.

example/bookstore/v1/bookstore.proto

@@ -836,7 +836,7 @@
     "/{path}:archive": {
       "post": {
         "summary": "archive a book.",
-        "operationId": "Bookstore_archiveBook",
+        "operationId": "Bookstore_ArchiveBook",
         "responses": {
           "200": {
             "description": "A successful response.",
@@ -981,14 +981,6 @@
     "v1Book": {
       "type": "object",
       "properties": {
-        "author": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "$ref": "#/definitions/BookAuthor"
-          },
-          "description": "Field for author."
-        },
         "isbn": {
           "type": "array",
           "items": {
@@ -997,8 +989,8 @@
           "description": "Field for isbn."
         },
         "price": {
-          "type": "number",
-          "format": "float",
+          "type": "integer",
+          "format": "int32",
           "description": "Field for price."
         },
         "published": {
@@ -1010,6 +1002,14 @@
           "format": "int32",
           "description": "Field for edition."
         },
+        "author": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/BookAuthor"
+          },
+          "description": "Field for author."
+        },
         "path": {
           "type": "string",
           "description": "Field for path."
@@ -1019,7 +1019,9 @@
       "required": [
         "isbn",
         "price",
-        "published"
+        "published",
+        "edition",
+        "author"
       ]
     },
     "v1BookEdition": {

example/bookstore/v1/bookstore.swagger.json

@@ -1,55 +1,58 @@
 # normally this would be suffixed with the domain (.com)
 name: "bookstore.example.com"
-url: "http://localhost:8081"
+server_url: "http://localhost:8081"
 contact:
   name: "API support"
   email: "aepsupport@aep.dev"
 resources:
-  # example of a simple resource
-  - kind: "publisher"
+  publisher:
+    singular: "publisher"
     plural: "publishers"
     schema:
-      type: "object"
+      type: object
       properties:
         description:
           type: string
           x-aep-field-number: 1
     methods:
-      create: {}
-      read: {}
+      create:
+        supports_user_settable_create: true
+      get: {}
       update: {}
       delete: {}
       list:
         supports_filter: true
         supports_skip: true
       apply: {}
-  # example of a child resource
-  - kind: "book"
+  book:
+    singular: "book"
     plural: "books"
-    # the parents should specify the parents of the resource. It takes in the
-    # kind.
-    parents:
-      - "publisher"
+    parents: ["publisher"]
     schema:
-      type: "object"
-      required: ["author", "isbn", "price", "published"]
+      type: object
+      required: ["author", "edition", "isbn", "price", "published"]
       properties:
         isbn:
+          type: array
           items:
             type: string
           x-aep-field-number: 1
         price:
-          type: float
+          type: integer
+          format: int32
           x-aep-field-number: 2
         published:
           type: boolean
           x-aep-field-number: 3
         edition:
           type: integer
+          format: int32
           x-aep-field-number: 4
         author:
+          type: array
           x-aep-field-number: 5
           items:
+            type: object
             properties:
               firstName:
                 type: string
@@ -58,73 +61,50 @@ resources:
                 type: string
                 x-aep-field-number: 2
     methods:
-      create: {}
-      read: {}
+      create:
+        supports_user_settable_create: true
+      get: {}
       update: {}
       delete: {}
       list:
         has_unreachable_resources: true
       apply: {}
-      custom:
-        - name: "archive"
-          method_type: POST
-          request:
-            type: "object"
-            properties: {}
-          response:
-            type: "object"
-            properties:
-              success:
-                type: boolean
-                x-aep-field-number: 1
-  # other example resources that might be interesting to add:
-  # authors, which could be a reference for book
-  # authors could have a reference to publishers too
-  # example of a child resource, with a redudant type name.
-  # aepc will remove the redundant component in the path pattern
-  - kind: "book-edition"
+    custom_methods:
+      - name: "archive"
+        method: "POST"
+        is_long_running: true
+        request:
+          type: object
+          properties: {}
+        response:
+          type: object
+          properties:
+            success:
+              type: boolean
+  book-edition:
+    singular: "book-edition"
     plural: "book-editions"
-    # the parents should specify the parents of the resource. It takes in the
-    # kind.
-    parents:
-      - "book"
+    parents: ["book"]
     schema:
+      type: object
       required: ["displayname"]
-      type: "object"
       properties:
         displayname:
-          x-aep-field-number: 1
           type: string
+          x-aep-field-number: 1
     methods:
-      create: {}
-      read: {}
+      create:
+        supports_user_settable_create: true
+      get: {}
       list: {}
       delete: {}
-  - kind: "isbn"
+  isbn:
+    singular: "isbn"
     plural: "isbns"
     schema:
-      type: "object"
+      type: object
     methods:
-      read: {}
+      get: {}
       list: {}
-      create: {}
-      # blocked on https://github.com/aep-dev/api-linter/issues/97
-      # non_client_settable_id: true
-  - kind: "operation"
-    plural: "operations"
-    schema:
-      x-aep-proto-message-name: "aep.api.Operation",
-      type: "object"
-      properties:
-        path:
-          type: string
-          x-aep-field-number: 1
-        metadata:
-          type: string
-          x-aep-field-number: 2
-        done:
-          type: boolean
-          x-aep-field-number: 3
-        response:
-          type: object
-          x-aep-field-number: 5
+      create:
+        supports_user_settable_create: true