Add Go code generator plugin #23

timburks · 2017-01-30T19:36:47Z

This set of commits adds a code generation plugin (written in Go) that generates Go code for API clients and servers for specified OpenAPI models. The plugin is not complete but intended as an illustration of a code generation plugin that could be built to work with openapic.

The plugins/go/openapi_go_generator/examples/bookstore contains an example and instructions for demonstrating the plugin.

This PR also includes a modification to openapic to pass plugin parameters as comma-separated key-value pairs.

…rator project.

…(incomplete) files.

…ctories.

… and services.

…o plugins

… generated code.

The Client struct encapsulates the service address.

… response sets.

…ates the OpenAPI Go generator plugin.

timburks · 2017-01-30T19:42:07Z

The unit test is failing because there's an extra blank line at the end of the plugin output. Investigating...

…e in a package.

guptasu

Overall looks great. Didn't get into the details of templates and service code, just looked at them briefly and they seem good. Reviewed the plugin and the option passing code. Have couple of minor comments there.

openapic/compiler.go

+		case 1:
+			outputLocation = invocationParts[0]
+		case 2:
+			parameters := strings.Split(invocationParts[0], ",")


openapic/compiler.go

+		switch len(invocationParts) {
+		case 1:
+			outputLocation = invocationParts[0]
+		case 2:


plugins/plugin.proto

@@ -84,18 +96,29 @@ message PluginResponse {
  // status code.
  repeated string error = 1;


plugins/plugin.proto

@@ -84,18 +96,29 @@ message PluginResponse {
  // status code.
  repeated string error = 1;

-  // text output
+  // text output, typically written to stdout by openapic.


plugins/go/openapi_go_generator/renderer.go

+	switch name {
+	case "integer":
+		if format == "int32" {
+			return "int32"


plugins/go/openapi_go_generator/examples/bookstore/bookstore_test.go

+ limitations under the License.
+*/
+
+package test


…nerated code.

…ling, and add tests.

openapic/compiler.go

 		var writer io.Writer
-		if pluginCall.Output == "-" {
+		if outputLocation == "!" {


openapic/compiler.go

 		writer = os.Stdout
+	} else if name == "=" {


plugins/plugin.proto


-  // The plugin parameter passed on the command-line.
-  string parameter = 2;
+  // The plugin invocation string, usually specified as a command-line option to the OpenAPI compiler.


guptasu · 2017-02-02T00:03:21Z

LGTM

… App Engine and standalone use.

…requests.

timburks added 23 commits January 10, 2017 22:22

Initial Go service generator plugin, imported from prior service gene…

25c8732

…rator project.

Enhance Go service generator plugin and openapic to write some basic …

b9fc9a5

…(incomplete) files.

Update compiler to write files generated by plugins to specified dire…

62ae6da

…ctories.

Some progress on generating structures.

351ec9b

Progress building parameters and responses objects in Go code generator.

90bb5ff

Adjust a few type names.

8da5e0a

Some progress on go service code generation example

d03cae0

Reorganize and simplify templates in go service generator example

1525cb9

Go service generator plugin now builds working bookstore example.

7fb037b

Go service generator calls gofmt to format generated Go code.

b1f9a64

Partial client code generator in go service generator example

df0119b

Refactoring go service generator into separate generators for clients…

0a87c5d

… and services.

Add option-passing to plugin interface, refactor go generator into tw…

7a093bc

…o plugins

Improve Go client and server generator to allow bookstore test to use…

3f7e97a

… generated code.

Clean up Go bookstore generated client and server, add a Client struct.

423d78c

The Client struct encapsulates the service address.

Merge openapi_go_client and openapi_go_service into openapi_go_generator

e117ba3

restructuring openapi_go_generator

80e275e

minor cleanup, add license headers to openapi_go_generator source files

1dd5477

Makefile for openapi_go_generator

8a47387

Improve go generator plugin to exclude types for unused parameter and…

c6da729

… response sets.

Add a few functions to simplify go generator templates

46f05e8

Add README and simplifications to the bookstore example that demonstr…

e4218e4

…ates the OpenAPI Go generator plugin.

Move examples into openapi_go_generator directory.

5114f11

timburks requested a review from guptasu January 30, 2017 19:37

timburks self-assigned this Jan 30, 2017

timburks added 3 commits January 30, 2017 11:59

Minor change to output-writing to fix project tests.

57af19e

Fix error in bookstore_test.go import path

829653e

Restructure code generated by openapi_go_generator to put service cod…

66d17d5

…e in a package.

guptasu reviewed Jan 31, 2017

View reviewed changes

timburks added 4 commits January 31, 2017 15:02

Refine packaged server code and examples, improve documentation in ge…

ed4be34

…nerated code.

Simplify plugin interface.

13c1362

Add regex validation of plugin parameters, improve general error-hand…

85f46b8

…ling, and add tests.

Add Travis testing of code generated by openapi_go_generator.

32721c4

timburks mentioned this pull request Feb 1, 2017

Build a demo code generation plugin #24

Closed

guptasu reviewed Feb 1, 2017

View reviewed changes

Remove unneeded "invocation" field from plugin Request message.

8f73f38

timburks added 5 commits February 1, 2017 18:37

Add error representaton and simplify bookstore service example.

e220249

Simplify service in bookstore server example.

cc6751a

Simplified the user-generated bookstore service code and verified for…

edece67

… App Engine and standalone use.

Improve error handling in openapi_go_generator generated code.

72df854

openapi_go_generator: remove unneeded logging and return 400 for bad …

aa6e028

…requests.

timburks merged commit 72ada8f into google:master Feb 2, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Go code generator plugin #23

Add Go code generator plugin #23

timburks commented Jan 30, 2017 •

edited

Loading

timburks commented Jan 30, 2017

guptasu left a comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

guptasu commented Feb 2, 2017

		@@ -84,18 +96,29 @@ message PluginResponse {
		// status code.
		repeated string error = 1;

Add Go code generator plugin #23

Add Go code generator plugin #23

Conversation

timburks commented Jan 30, 2017 • edited Loading

timburks commented Jan 30, 2017

guptasu left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

guptasu commented Feb 2, 2017

timburks commented Jan 30, 2017 •

edited

Loading