Back to Apievangelist

Operations

api-operations.md

latest4.2 KB
Original Source

API Evangelist Network API

API Evangelist Network API

Operations

Strategies, experiences, and the stops along the API lifecycle.


Strategies

GET https://api.apievangelist.com/v1

/strategies

Search or browse the strategies collection (75) — API strategy patterns.

Strategies › query Parameters

q ​string

Free-text query over title, summary, tags, and body.

tags ​string

Comma-separated tag slugs.

match ​string · enum

Tag match mode.

Enum values: any

all

Default: any

fields ​string

Comma-separated sparse field projection.

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

Strategies › Responses

200

Paged strategies.

PagedEnvelope

meta ​object

dataDoc[]


Strategy

GET https://api.apievangelist.com/v1

/strategies/{slug}

One entry from the strategies collection; include=content adds the full body.

Strategy › path Parameters

slug ​string · required

Strategy › query Parameters

include ​string · enum

Set to content to inline the full markdown body (up to 200 KB).

Enum values: content

Strategy › Responses

200404

The entry.

Doc

type ​string

slug ​string

title ​string

summary ​string

url ​string · uri

tags ​string[]

date ​string

content ​string

Full markdown body when include=content.


Experiences

GET https://api.apievangelist.com/v1

/experiences

Search or browse the experiences collection (46) — API producer and consumer experience patterns.

Experiences › query Parameters

q ​string

Free-text query over title, summary, tags, and body.

tags ​string

Comma-separated tag slugs.

match ​string · enum

Tag match mode.

Enum values: any

all

Default: any

fields ​string

Comma-separated sparse field projection.

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

Experiences › Responses

200

Paged experiences.

PagedEnvelope

meta ​object

dataDoc[]


Experience

GET https://api.apievangelist.com/v1

/experiences/{slug}

One entry from the experiences collection; include=content adds the full body.

Experience › path Parameters

slug ​string · required

Experience › query Parameters

include ​string · enum

Set to content to inline the full markdown body (up to 200 KB).

Enum values: content

Experience › Responses

200404

The entry.

Doc

type ​string

slug ​string

title ​string

summary ​string

url ​string · uri

tags ​string[]

date ​string

content ​string

Full markdown body when include=content.


Lifecycle

GET https://api.apievangelist.com/v1

/lifecycle

Search or browse the lifecycle collection (29) — stops along the API lifecycle.

Lifecycle › query Parameters

q ​string

Free-text query over title, summary, tags, and body.

tags ​string

Comma-separated tag slugs.

match ​string · enum

Tag match mode.

Enum values: any

all

Default: any

fields ​string

Comma-separated sparse field projection.

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

Lifecycle › Responses

200

Paged lifecycle.

PagedEnvelope

meta ​object

dataDoc[]


Lifecycle Stage

GET https://api.apievangelist.com/v1

/lifecycle/{slug}

One stop along the API lifecycle; include=content adds the full body.

Lifecycle Stage › path Parameters

slug ​string · required

Lifecycle Stage › query Parameters

include ​string · enum

Set to content to inline the full markdown body (up to 200 KB).

Enum values: content

Lifecycle Stage › Responses

200404

The entry.

Doc

type ​string

slug ​string

title ​string

summary ​string

url ​string · uri

tags ​string[]

date ​string

content ​string

Full markdown body when include=content.


ToolboxMedia