Giter Club home page Giter Club logo

the-api-book's Introduction

This is the working repository for ‘The API’ book written by Sergey Konstantinov (email, Linkedin profile).

Current State and the Roadmap

Right now Section I (‘API Design’) and Section II (‘Backwards Compatibility’) are finished. The Sections are lacking readable schemes, I'll draw them later.

Section III ‘API as a Product’ will be discussing non-technical issues

  • what for the APIs exist;
  • monetizing APIs;
  • making sure you understand users' needs and collect proper metrics;
  • common practices, including AA issues and fraud problems;
  • organizing docs portal;
  • open source and community.

I also have more distant plans on adding two more subsections to Section I.

  • Section Ia ‘JSON HTTP APIs’:
    • the REST myth;
    • following HTTP spec, including those parts where you should not follow the spec;
    • best practices;
  • Section Ib ‘SDK Design’ covering more tricky issues of having proving UI alongside the API (no specific plan right now)

Translation

I am translating new chapters into English at the moment they're ready. I'm not a native speaker, so feel free to correct my grammar.

Contributing

I am accepting inquiries. Feel free to open issues.

I am NOT accepting pull requests introducing any new content, since I'm willing to be the only author. I would gratefully accept typo fixes, though.

Thanks art.mari.ka for the illustration & inspiration.

Thanks Ilya Subbotin and Fedor Golubev for the valuable feedback.

Thanks @tholman for https://github.com/tholman/github-corners.

Thanks Ira Gorelik for the Aqueduct.

Thanks ParaType for PT Sans and PT Serif.

Thanks Christian Robertson for Roboto Mono.

the-api-book's People

Contributors

twirl avatar angryermine avatar callista-del-mar avatar cliffart44 avatar kaznovac avatar yegorz avatar cobr123 avatar dreig avatar gitbook-bot avatar lynxknight avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.