com.smartbear.swagger4j
Interface Api

All Known Implementing Classes:
ApiImpl

public interface Api

Holds a Swagger API defined in an API Declaration - see https://github.com/wordnik/swagger-core/wiki/API-Declaration


Method Summary
 Operation addOperation(String nickName, Operation.Method method)
          Creates a new Operation with the specified nickName and HTTP Method
 String getDescription()
           
 Operation getOperation(String nickName)
           
 List<Operation> getOperations()
           
 String getPath()
           
 void removeOperation(Operation operation)
           
 void setDescription(String description)
           
 void setPath(String path)
           
 

Method Detail

getPath

String getPath()

setPath

void setPath(String path)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getOperation

Operation getOperation(String nickName)

getOperations

List<Operation> getOperations()

removeOperation

void removeOperation(Operation operation)

addOperation

Operation addOperation(String nickName,
                       Operation.Method method)
Creates a new Operation with the specified nickName and HTTP Method

Parameters:
nickName - the unique nickName of this operation
method - the HTTP method
Returns:
an empty Operation object


Copyright © 2013. All Rights Reserved.