package
4.2.3+incompatible
Repository: https://github.com/mmalygin/openapi-generator.git
Documentation: pkg.go.dev

# README

Go API Server for petstoreserver

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

Overview

This server was generated by the [openapi-generator] (https://openapi-generator.tech) project. By using the OpenAPI-Spec from a remote server, you can easily generate a server stub.

To see how to make this your own, look here:

README

  • API version: 1.0.0

Running the server

To run the server, follow these simple steps:

go run main.go

To run the server in a docker container

docker build --network=host -t petstoreserver .

Once the image is built, just run

docker run --rm -it petstoreserver 

Known Issue

Endpoints sharing a common path may result in issues. For example, /v2/pet/findByTags and /v2/pet/:petId will result in an issue with the Gin framework. For more information about this known limitation, please refer to gin-gonic/gin#388 for more information.

A workaround is to manually update the path and handler. Please refer to gin-gonic/gin/issues/205#issuecomment-296155497 for more information.

# Functions

AddPet - Add a new pet to the store.
Call123TestSpecialTags - To test special tags.
CreateUser - Create user.
CreateUsersWithArrayInput - Creates list of users with given input array.
CreateUsersWithListInput - Creates list of users with given input array.
DeleteOrder - Delete purchase order by ID.
DeletePet - Deletes a pet.
DeleteUser - Delete user.
FakeHealthGet - Health check endpoint.
FakeOuterBooleanSerialize - .
FakeOuterCompositeSerialize - .
FakeOuterNumberSerialize - .
FakeOuterStringSerialize - .
FindPetsByStatus - Finds Pets by status.
FindPetsByTags - Finds Pets by tags.
FooGet - .
GetInventory - Returns pet inventories by status.
GetOrderById - Find purchase order by ID.
GetPetById - Find pet by ID.
GetUserByName - Get user by user name.
Index is the index handler.
LoginUser - Logs user into the system.
LogoutUser - Logs out current logged in user session.
NewRouter returns a new router.
PlaceOrder - Place an order for a pet.
TestBodyWithFileSchema - .
TestBodyWithQueryParams - .
TestClassname - To test class name in snake case.
TestClientModel - To test \"client\" model.
TestEndpointParameters - Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 .
TestEnumParameters - To test enum parameters.
TestGroupParameters - Fake endpoint to test group parameters (optional).
TestInlineAdditionalProperties - test inline additionalProperties.
TestJsonFormData - test json serialization of form data.
TestQueryParameterCollectionFormat - .
UpdatePet - Update an existing pet.
UpdatePetWithForm - Updates a pet in the store with form data.
UpdateUser - Updated user.
UploadFile - uploads an image.
UploadFileWithRequiredFile - uploads an image (required).

# Constants

List of EnumClass.
List of OuterEnum.
List of OuterEnumDefaultValue.
List of OuterEnum.
List of OuterEnumDefaultValue.
List of EnumClass.
List of OuterEnum.
List of OuterEnumDefaultValue.
List of EnumClass.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClassModel - Model for testing model with \"_class\" property.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
File - Must be named `File` for test.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HealthCheckResult - Just a string to inform instance is up and running.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Model200Response - Model for testing model name starting with number.
Name - Model for testing model name same as property name.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Return - Model for testing reserved words.
Route is the information for every URI.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Routes is the list of the generated Route.