org.davidmoten.oa3.codegen.test.library.service

Interface Service

All Superinterfaces:

ErrorHandler

@Generated(value="com.github.davidmoten:openapi-codegen-runtime:0.1.5")
public interface Service
extends ErrorHandler

Library Demo

Library demonstration of some features of OpenAPI 3 and openapi-codegen

Method Summary

Modifier and Type	Method and Description
default void	createUser(User requestBody) Creates a new user
default void	deleteUser(String id) Deletes a user (logically)
default Item	getItem(String itemId) Gets item details
default User	getUser(String id) Gets user details
default UsersPage	getUsers(Optional<String> search, Optional<String> continuationToken) List users page by page, filtered by search if present
default void	updateUser(String id, User requestBody) Updates a user

Methods inherited from interface org.davidmoten.oa3.codegen.spring.runtime.ErrorHandler

errorResponse, errorResponseBody, notImplemented, response

Method Detail

getUsers

default UsersPage getUsers(Optional<String> search,
                           Optional<String> continuationToken)
                    throws ServiceException

List users page by page, filtered by search if present

[status=200, application/json] --> UsersPage

Parameters:

search - search

continuationToken - continuationToken

Returns:

primary response status code 200

Throws:

ServiceException

createUser

default void createUser(User requestBody)
                 throws ServiceException

Creates a new user

Parameters:

requestBody - requestBody

Throws:

ServiceException

getUser

default User getUser(String id)
              throws ServiceException

Gets user details

[status=200, application/json] --> User

Parameters:

id - id

Returns:

primary response status code 200

Throws:

ServiceException

updateUser

default void updateUser(String id,
                        User requestBody)
                 throws ServiceException

Updates a user

Parameters:

requestBody - requestBody

id - id

Throws:

ServiceException

deleteUser

default void deleteUser(String id)
                 throws ServiceException

Deletes a user (logically)

Parameters:

id - id

Throws:

ServiceException

getItem

default Item getItem(String itemId)
              throws ServiceException

Gets item details

[status=200, application/json] --> Item

Parameters:

itemId - itemId

Returns:

primary response status code 200

Throws:

ServiceException