User:DKinzler (WMF)/API Guidelines: Difference between revisions

• API Guidelines | Product Brief

For Maintainers

• Wikimedia_Engineering_Architecture_Principles#api/domain
• Core Platform Team/Initiative/Core REST API in Mediawiki/Design principles
• https://wikitech.wikimedia.org/wiki/Services/FirstDeployment
• https://wikitech.wikimedia.org/wiki/ServiceOwnership
• https://wikitech.wikimedia.org/wiki/Deployment_pipeline
• https://github.com/wikimedia/service-template-node
• API Life Cycle (draft by Daniel)
• API versioning
  • https://phabricator.wikimedia.org/T232485 REST Versioning RFC
• Service-template-node/APIDesign
• https://api.wikimedia.org/wiki/Community/API_guidelines
• wikitech:API_Gateway#How_to_design_your_API
• meta:User:BPirkle (WMF)/Stuff/Designing APIs
• "Good API, Great API" Google Doc
• Authorization and Rate Limiting: https://docs.google.com/document/d/1pG2qd4w_RW7wl_6Od1jFo4CkKA3zCA2wQDtmY2e5Tb8/edit#
• API:Cross-site requests
• Ideas:
  • paging?
  • localization (mostly for errors)

For Clients

• API Life Cycle -> stable interface
• https://meta.wikimedia.org/wiki/User-Agent_policy
• API:Etiquette
• https://api.wikimedia.org/wiki/Documentation/Best_practices
• https://foundation.wikimedia.org/wiki/Terms_of_Use/en
• Manual:Creating a bot
• en:Wikipedia:Bot_policy
• RESTbase Swagger UI https://en.wikipedia.org/api/rest_v1/
• Wikidata Data access best practices

Bill's Links

• https://cloud.google.com/apis/design
• https://opensource.zalando.com/restful-api-guidelines/index.html#table-of-contents
• https://meta.stoplight.io/docs/platform/52ab0a117eadd-welcome-to-the-stoplight-docs
• https://docs.google.com/spreadsheets/d/174pZRPhdL9bMec-87Eho8HB5kV7Ua14fyrxuxoENoh4/edit#gid=1711717114
• https://docs.google.com/document/d/1h_nvjACYnvqrq93REnubafGckRXqUga3N56bPBPcn9k/edit?pli=1#heading=h.w29abfmznz7v

Search / WDQS

• https://wikitech.wikimedia.org/wiki/Search/Technical_interactions
• https://wikitech.wikimedia.org/wiki/Wikidata_Query_Service/Technical_interactions