From 7b52da5d57ab7879949f17f9ae8d7d38c69bdbab Mon Sep 17 00:00:00 2001 From: Tim Grein Date: Sat, 13 Jul 2024 10:35:04 +0200 Subject: [PATCH] [go-server] Add information, where the server runs to generated README.md (#19141) * Add information, where the server runs to README.md * Update samples --- .../src/main/resources/go-server/README.mustache | 3 ++- samples/openapi3/server/petstore/go/go-petstore/README.md | 3 ++- samples/server/others/go-server/no-body-path-params/README.md | 3 ++- samples/server/petstore/go-api-server/README.md | 3 ++- samples/server/petstore/go-chi-server/README.md | 3 ++- 5 files changed, 10 insertions(+), 5 deletions(-) diff --git a/modules/openapi-generator/src/main/resources/go-server/README.mustache b/modules/openapi-generator/src/main/resources/go-server/README.mustache index 21cbc2ed198..4470bb93b11 100644 --- a/modules/openapi-generator/src/main/resources/go-server/README.mustache +++ b/modules/openapi-generator/src/main/resources/go-server/README.mustache @@ -8,7 +8,6 @@ This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. -- To see how to make this your own, look here: @@ -31,6 +30,8 @@ To run the server, follow these simple steps: go run main.go ``` +The server will be available on `http://localhost:{{serverPort}}`. + To run the server in a docker container ``` docker build --network=host -t {{{packageName}}} . diff --git a/samples/openapi3/server/petstore/go/go-petstore/README.md b/samples/openapi3/server/petstore/go/go-petstore/README.md index 70a581e5010..5a8011d7c22 100644 --- a/samples/openapi3/server/petstore/go/go-petstore/README.md +++ b/samples/openapi3/server/petstore/go/go-petstore/README.md @@ -6,7 +6,6 @@ This is a sample server Petstore server. For this sample, you can use the api ke This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. -- To see how to make this your own, look here: @@ -23,6 +22,8 @@ To run the server, follow these simple steps: go run main.go ``` +The server will be available on `http://localhost:8080`. + To run the server in a docker container ``` docker build --network=host -t petstoreserver . diff --git a/samples/server/others/go-server/no-body-path-params/README.md b/samples/server/others/go-server/no-body-path-params/README.md index 20b2bbf51d6..7201fb1e781 100644 --- a/samples/server/others/go-server/no-body-path-params/README.md +++ b/samples/server/others/go-server/no-body-path-params/README.md @@ -6,7 +6,6 @@ No description provided (generated by Openapi Generator https://github.com/opena This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. -- To see how to make this your own, look here: @@ -23,6 +22,8 @@ To run the server, follow these simple steps: go run main.go ``` +The server will be available on `http://localhost:8080`. + To run the server in a docker container ``` docker build --network=host -t petstoreserver . diff --git a/samples/server/petstore/go-api-server/README.md b/samples/server/petstore/go-api-server/README.md index 70a581e5010..5a8011d7c22 100644 --- a/samples/server/petstore/go-api-server/README.md +++ b/samples/server/petstore/go-api-server/README.md @@ -6,7 +6,6 @@ This is a sample server Petstore server. For this sample, you can use the api ke This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. -- To see how to make this your own, look here: @@ -23,6 +22,8 @@ To run the server, follow these simple steps: go run main.go ``` +The server will be available on `http://localhost:8080`. + To run the server in a docker container ``` docker build --network=host -t petstoreserver . diff --git a/samples/server/petstore/go-chi-server/README.md b/samples/server/petstore/go-chi-server/README.md index 70a581e5010..5a8011d7c22 100644 --- a/samples/server/petstore/go-chi-server/README.md +++ b/samples/server/petstore/go-chi-server/README.md @@ -6,7 +6,6 @@ This is a sample server Petstore server. For this sample, you can use the api ke This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. -- To see how to make this your own, look here: @@ -23,6 +22,8 @@ To run the server, follow these simple steps: go run main.go ``` +The server will be available on `http://localhost:8080`. + To run the server in a docker container ``` docker build --network=host -t petstoreserver .