openapi

Documentation

Overview

Package openapi provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.13.0 DO NOT EDIT.

Index

• func RegisterHandlers(router gin.IRouter, si ServerInterface)
• func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)
• type GinServerOptions
• type MiddlewareFunc
• type ServerInterface
• type ServerInterfaceWrapper
  • func (siw *ServerInterfaceWrapper) GetFollowers(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetFollowing(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetMe(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetMessages(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetRoomUsers(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetRooms(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) GetUserByID(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PatchFollowing(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PatchRoom(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostFollowing(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostLogin(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostMe(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostMessage(c *gin.Context)
  • func (siw *ServerInterfaceWrapper) PostRoom(c *gin.Context)

Functions

func RegisterHandlers

func RegisterHandlers(router gin.IRouter, si ServerInterface)

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions

func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type GinServerOptions

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

GinServerOptions provides options for the Gin server.

type MiddlewareFunc

type MiddlewareFunc func(c *gin.Context)

type ServerInterface

type ServerInterface interface {
	// ログイン処理。
	// (POST /api/login)
	PostLogin(c *gin.Context)
	// 自分が参加しているルーム一覧。
	// (GET /api/rooms)
	GetRooms(c *gin.Context)
	// ルーム情報を更新する。
	// (PATCH /api/rooms)
	PatchRoom(c *gin.Context)
	// ルームを新規作成する。
	// (POST /api/rooms)
	PostRoom(c *gin.Context)
	// 指定したルームでの未読メッセージ一覧を取得する。
	// (GET /api/rooms/:roomID/messages)
	GetMessages(c *gin.Context, params GetMessagesParams)
	// 指定したルームに新着メッセージを投稿する。
	// (POST /api/rooms/:roomID/messages)
	PostMessage(c *gin.Context)
	// 指定したルームに所属するユーザー一覧。
	// (GET /api/rooms/:roomID/users)
	GetRoomUsers(c *gin.Context)
	// 友達追加されてるが、自分からは追加していないユーザー一覧。
	// (GET /api/users/followers)
	GetFollowers(c *gin.Context)
	// 自分が友達追加しているユーザー一覧。
	// (GET /api/users/following)
	GetFollowing(c *gin.Context)
	// 友達の情報を更新する。
	// (PATCH /api/users/following/{user_id})
	PatchFollowing(c *gin.Context, userId UserIdPath)
	// 他人のユーザーアカウントを友達に追加する。
	// (POST /api/users/following/{user_id})
	PostFollowing(c *gin.Context, userId UserIdPath)
	// ログインしている（セッションを発行した）ユーザーの情報を取得する。
	// (GET /api/users/me)
	GetMe(c *gin.Context)
	// ログインしている（セッションを発行した）ユーザーの情報を変更する。
	// (PATCH /api/users/me)
	PostMe(c *gin.Context)
	// 他人を友達追加するための検索（ユーザー ID を使用）。
	// (GET /api/users/{user_id})
	GetUserByID(c *gin.Context, userId UserIdPath)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) GetFollowers

func (siw *ServerInterfaceWrapper) GetFollowers(c *gin.Context)

GetFollowers operation middleware

func (*ServerInterfaceWrapper) GetFollowing

func (siw *ServerInterfaceWrapper) GetFollowing(c *gin.Context)

GetFollowing operation middleware

func (*ServerInterfaceWrapper) GetMe

func (siw *ServerInterfaceWrapper) GetMe(c *gin.Context)

GetMe operation middleware

func (*ServerInterfaceWrapper) GetMessages

func (siw *ServerInterfaceWrapper) GetMessages(c *gin.Context)

GetMessages operation middleware

func (*ServerInterfaceWrapper) GetRoomUsers

func (siw *ServerInterfaceWrapper) GetRoomUsers(c *gin.Context)

GetRoomUsers operation middleware

func (*ServerInterfaceWrapper) GetRooms

func (siw *ServerInterfaceWrapper) GetRooms(c *gin.Context)

GetRooms operation middleware

func (*ServerInterfaceWrapper) GetUserByID

func (siw *ServerInterfaceWrapper) GetUserByID(c *gin.Context)

GetUserByID operation middleware

func (*ServerInterfaceWrapper) PatchFollowing

func (siw *ServerInterfaceWrapper) PatchFollowing(c *gin.Context)

PatchFollowing operation middleware

func (*ServerInterfaceWrapper) PatchRoom

func (siw *ServerInterfaceWrapper) PatchRoom(c *gin.Context)

PatchRoom operation middleware

func (*ServerInterfaceWrapper) PostFollowing

func (siw *ServerInterfaceWrapper) PostFollowing(c *gin.Context)

PostFollowing operation middleware

func (*ServerInterfaceWrapper) PostLogin

func (siw *ServerInterfaceWrapper) PostLogin(c *gin.Context)

PostLogin operation middleware

func (*ServerInterfaceWrapper) PostMe

func (siw *ServerInterfaceWrapper) PostMe(c *gin.Context)

PostMe operation middleware

func (*ServerInterfaceWrapper) PostMessage

func (siw *ServerInterfaceWrapper) PostMessage(c *gin.Context)

PostMessage operation middleware

func (*ServerInterfaceWrapper) PostRoom

func (siw *ServerInterfaceWrapper) PostRoom(c *gin.Context)

PostRoom operation middleware