Back to Apievangelist

Guidance

api-guidance.md

latest4.8 KB
Original Source

API Evangelist Network API

API Evangelist Network API

Guidance

Editorial guidance across the history, technology, business, politics, governance, and evangelism of APIs.


History

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

/guidance/sections/history

Guidance from the history of APIs — the providers, tooling, and moments that shaped the space.

History › query Parameters

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

fields ​string

Comma-separated sparse field projection.

History › Responses

200

Paged guidance tagged History.

PagedEnvelope

meta ​object

dataDoc[]


Technology

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

/guidance/sections/technology

Guidance on the technology of APIs — protocols, patterns, and the technical landscape.

Technology › query Parameters

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

fields ​string

Comma-separated sparse field projection.

Technology › Responses

200

Paged guidance tagged Technology.

PagedEnvelope

meta ​object

dataDoc[]


Business

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

/guidance/sections/business

Guidance on the business of APIs — monetization, plans, partners, and go-to-market.

Business › query Parameters

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

fields ​string

Comma-separated sparse field projection.

Business › Responses

200

Paged guidance tagged Business.

PagedEnvelope

meta ​object

dataDoc[]


Politics

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

/guidance/sections/politics

Guidance on the politics of APIs — regulation, privacy, terms of service, and power.

Politics › query Parameters

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

fields ​string

Comma-separated sparse field projection.

Politics › Responses

200

Paged guidance tagged Politics.

PagedEnvelope

meta ​object

dataDoc[]


Governance

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

/guidance/sections/governance

Guidance on API governance — aligning policies, rules, and lifecycle across operations.

Governance › query Parameters

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

fields ​string

Comma-separated sparse field projection.

Governance › Responses

200

Paged guidance tagged Governance.

PagedEnvelope

meta ​object

dataDoc[]


Evangelism

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

/guidance/sections/evangelism

Guidance on API evangelism — carrying the API message and earning adoption.

Evangelism › query Parameters

page ​integer · min: 1

Default: 1

limit ​integer · min: 1 · max: 100

Default: 25

fields ​string

Comma-separated sparse field projection.

Evangelism › Responses

200

Paged guidance tagged Evangelism.

PagedEnvelope

meta ​object

dataDoc[]


Guidance

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

/guidance

Search or browse the full guidance collection (177) — editorial guidance for API producers and consumers.

Guidance › 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

Guidance › Responses

200

Paged guidance.

PagedEnvelope

meta ​object

dataDoc[]


Guidance Entry

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

/guidance/{slug}

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

Guidance Entry › path Parameters

slug ​string · required

Guidance Entry › query Parameters

include ​string · enum

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

Enum values: content

Guidance Entry › 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.


AreasGovernance