Haufe-Lexware/api-style-guide

Issues

• Define API Discovery Format

  #35 opened 7 years ago by hlgr360
  7

• Drop the requirement of the API review?

  #45 opened 7 years ago by hlgr360
  6

• Clarifying use of schema for documentation, not code generation

  #44 opened 7 years ago by hlgr360
  0

• add section on the need for api evangelism

  #41 opened 7 years ago by hlgr360
  0

• Clarify use of GraphQL for mobile app interfaces only when using React/Redux

  #40 opened 7 years ago by hlgr360
  0

• Add batch API (design) guidance

  #39 opened 7 years ago by hlgr360
  0

• Re-evaluate (in 11/2017) error response formats

  #37 opened 7 years ago by chludwig-haufe
  0

• Explicitly ban snake-syntax

  #34 opened 7 years ago by hlgr360
  0

• Reemphasize design guidance on API first and Code second

  #19 opened 8 years ago by hlgr360
  1

• Add hiding of internal codes

  #33 opened 7 years ago by hlgr360
  0

• Sketch out hypermedia interaction pattern (incl caching and service document)

  #26 opened 7 years ago by hlgr360
  5

• Add best practices from QT API guide

  #31 opened 7 years ago by hlgr360
  0

• Describe the API to micro service mapping

  #28 opened 7 years ago by hlgr360
  2

• Add discussion of idempotency

  #30 opened 7 years ago by hlgr360
  0

• Add Fielding Property Maps

  #29 opened 7 years ago by hlgr360
  0

• Sharpen argument for hypermedia and add list of client libs/projects

  #25 opened 7 years ago by hlgr360
  1

• Add chapter on client-controlled resource representation

  #24 opened 7 years ago by hlgr360
  0

• Add chapter on Webhooks

  #22 opened 8 years ago by hlgr360
  1

• Add overall API Lifecycle guidance

  #10 opened 9 years ago by hlgr360
  0

• Make versioning and the notion of evolving API more visible

  #15 opened 8 years ago by DonMartin76
  1

• Obtain permission from James Higginbotham for summarizing design process

  #17 opened 8 years ago by hlgr360
  1

• Add link to swagger blog entry to api style guide

  #16 opened 8 years ago by hlgr360
  0

• Rework of API Styleguide to clearly state preferences

  #8 opened 8 years ago by hlgr360
  1

• Add API Design review process

  #9 opened 8 years ago by hlgr360
  1

• Proposal: Add a section for valid and invalide url patterns

  #11 opened 8 years ago by gabiBrysch
  1

• Composite Id as Ressource Id - URL structure

  #3 opened 9 years ago by MariusSchumann
  4