Api Class Reference

Inheritance diagram for Api:

Collaboration diagram for Api:

Public Member Functions
	__init__ (self)
	load (self, api_json, processor, context)
Public Member Functions inherited from Stringify
	__repr__ (self)

Data Fields
	description
	has_websocket
	operations
	path
	required_fields

Static Public Attributes
list	required_fields = ['path', 'operations']

Detailed Description

Model of a single API in an API declaration.

See https://github.com/wordnik/swagger-core/wiki/API-Declaration

Definition at line 435 of file swagger_model.py.

Constructor & Destructor Documentation

__init__()

__init__

(

self

)

Definition at line 443 of file swagger_model.py.

    def __init__(self,):
        self.path = None
        self.description = None
        self.operations = []
 

Member Function Documentation

load()

load	(		self,
			api_json,
			processor,
			context
	)

Definition at line 448 of file swagger_model.py.

    def load(self, api_json, processor, context):
        context = context.next_stack(api_json, 'path')
        validate_required_fields(api_json, self.required_fields, context)
        self.path = api_json.get('path')
        self.description = api_json.get('description')
        op_json = api_json.get('operations')
        self.operations = [
            Operation().load(j, processor, context) for j in op_json]
        self.has_websocket = any(op.is_websocket for op in self.operations)
        processor.process_api(self, context)
        return self
 
 

Referenced by ApiDeclaration.load_file(), and ResourceListing.load_file().

Field Documentation

description

description

Definition at line 445 of file swagger_model.py.

has_websocket

has_websocket

Definition at line 456 of file swagger_model.py.

operations

operations

Definition at line 446 of file swagger_model.py.

path

path

Definition at line 444 of file swagger_model.py.

required_fields [1/2]

list required_fields = ['path', 'operations']

static

Definition at line 441 of file swagger_model.py.

required_fields [2/2]

required_fields

Definition at line 450 of file swagger_model.py.

---

The documentation for this class was generated from the following file:

• swagger_model.py