API Design Guidelines

Welcome to the API Design Guidelines repository. The main goal of this project is to create the universal guidelines for designing an API based on the real-world usage and research on the subject.

These guidelines are currently only written in Croatian for the ease of use by the Croatian native speakers.

Dobrodošli u projekt Smjernice dizajna API-ja! Cilj ovog projekta je izraditi univerzalne smjernice za dizajn API-ja temeljene na stvarnoj uporabi i istraživanjima o API-jima.

Koja je svrha ovog projekta?

U današnjem svijetu razvoja softvera, kvalitetan dizajn API-ja ključan je za izgradnju skalabilnih, održivih i korisnicima pristupačnih softverskih rješenja. Misija projekta je:

• Unaprijediti kvalitetu API-ja kroz jasno definirane smjernice.
• Povećati interoperabilnost među različitim sustavima i platformama.
• Poticati dosljednost i standardizaciju u dizajnu API-ja.
• Olakšati učenje i implementaciju najboljih praksi za sve razine programera.

Izvori inspiracije

Ovaj projekt se temelji na bogatom iskustvu i smjernicama vodećih tehnoloških kompanija, kao i na projektima otvorenog koda i provedenim istraživanjima na tu temu:

• Projekti otvorenog koda:
  • Microsoft API Guidelines: https://github.com/microsoft/api-guidelines/
  • Google API Improvement Proposals: https://google.aip.dev/
  • JSON API: https://jsonapi.org/
  • Zalando RESTful API and Event Guidelines: https://opensource.zalando.com/restful-api-guidelines/
• Knjige:
  • API Design Patterns by JJ Geewax (ISBN: 978-1617295850)
  • Designing Web APIs by Brenda Jin, Saurabh Sahni, Amir Shevat (ISBN: 9781492026921)
• Članci:
  • How to design a RESTful API architecture from a human-language spec: https://www.oreilly.com/content/how-to-design-a-restful-api-architecture-from-a-human-language-spec/
  • How We Design Our APIs at Slack: https://slack.engineering/how-we-design-our-apis-at-slack/
  • Do RESTful API design rules have an impact on the understandability of Web APIs?: https://doi.org/10.1007/s10664-023-10367-y

Kako sudjelovati

Slobodno sudjelujte u ovom projektu! Evo kako možete pomoći:

1. Doprinesite smjernicama: Pregledajte postojeće smjernice, predložite poboljšanja ili nove smjernice.
2. Doprinesite primjerima: Pregledajte smjernice te predložite nove primjere ili izmjenu postojećih primjera.
3. Doprinesite formatiranjem: Predložite izmjene u formatiranju teksta za poboljšanje čitljivosti ili bolje isticanje bitnijih stavki.
4. Podijelite povratne informacije: Vaše mišljenje je važno! Pomozite unaprijediti smjernice dajući povratne informacije.
5. Širite riječ: Podijelite ovaj projekt s kolegama i širom zajednicom softver developera.

Uporaba projekta

Za početak, klonirajte repozitorij i pregledajte dokumentaciju:

git clone https://github.com/mkapulica/api-design-guidelines.git
cd api-design-guidelines