GithubHelp home page GithubHelp logo

Version number about corpus-db HOT 2 CLOSED

jonathanreeve avatar jonathanreeve commented on May 26, 2024
Version number

from corpus-db.

Comments (2)

JonathanReeve avatar JonathanReeve commented on May 26, 2024

I thought about this, but I ended up deciding that it just looks friendlier without the version number there, for now. If I make it to 2.0, and anyone at all is using this thing, then I might do something like /api2/.

from corpus-db.

smythp avatar smythp commented on May 26, 2024

OK. Only issue is that if I, or someone else, makes a script using this version, and then you update it, you're stuck either keeping all the endpoints the same or breaking the scripts. As an API designer you're making an implicit contract with the user, if you change stuff then people will be hesitant to build anything with it.

You might consider supporting an optional query parameter that allows the old version. Alternatively you could call all of this a beta and just say it's not ready for prime time yet. Since you have to support old versions once you have them that might be the way to go. But I do feel like an API is not like a website, if people are building stuff then you have to trust that stuff won't break.

from corpus-db.

Related Issues (20)

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.