Restify: API-Version in URL

Question

Derzeit in Entwicklung der API mit Restify und kann immer noch nicht daran gewöhnen, die API-Version in den Headern anzugeben. Es scheint einfach nicht sehr benutzerfreundlich.

Gibt es eine Möglichkeit für die Version, Teil der URL zu sein?

Beispiel wäre:

http://domain.com/api/v1/action 

Oder noch besser in meinem Fall:

http://api.domain.com/v1/action 

Dank

Answer 1

Sie können auch Restify verwenden, um Ihre Versionen zu definieren:

var server = restify.createServer({ 
    name: 'myAPI', 
    versions: ['1.0.0', '2.0.0'] 
}); 

Und dann diese Middleware verwenden, um mit server.pre:

server.pre(function (req, res, next) { 
    var pieces = req.url.replace(/^\/+/, '').split('/'); 
    var version = pieces[0]; 

    // only if you want to use this routes: 
    // /api/v1/resource 
    // /api/v1.0/resource 
    // /api/v1.0.0/resource 
    if (!semver.valid(version)) { 
     version = version.replace(/v(\d{1})\.(\d{1})\.(\d{1})/, '$1.$2.$3'); 
     version = version.replace(/v(\d{1})\.(\d{1})/, '$1.$2.0'); 
     version = version.replace(/v(\d{1})/, '$1.0.0'); 
    } 

    if (semver.valid(version) && server.versions.indexOf(version) > -1) { 
     req.url = req.url.replace(version + '/', ''); 
     req.headers['accept-version'] = version; 
    } 

    return next(); 
}); 

schließlich in Ihre Routen können Sie etwas tun:

server.get({ path: '/resource/:id', version: '1.0.0' }, function() { 
    // send object in version 1.0.0 
}); 

server.get({ path: '/resource/:id', version: '2.0.0' }, function() { 
    // send object in version 2.0.0 
}); 

Beispiele:

• http://api.domain.com/resource/10
• http://api.domain.com/2.0.0/resource/10
• http://api.domain.com/1.0.0/resource/10

Die obigen Beispiele folgen die Standards, denn wenn Version durch Kopf- oder URL nicht angegeben ist, die letzte Version zeigt.

UPDATE:

Ich habe eine Plugin-API-Versionen in URL zu haben: https://www.npmjs.com/package/restify-url-semver

Answer 2

Menschen richtig sind, dass es nicht durch restify unterstützt wird, aber ich dachte, ich würde werfen Sie meine Lösung für dieses Problem in den Mix. Ich mache so etwas wie dieses (Warnung, nicht getesteten Code folgen):

Nachdem ich einen Server erstellen, aber VOR ich die Routen erklären, melde ich einen benutzerdefinierten Parser die URL-style-Version Spezifizierer in ein übersetzen HTTP-style specifier:

server.use(versionParser); 

Und versionParser.js sieht ungefähr so ​​aus:

var semver = require('semver'); 
var restify = require('restify'); 

module.exports = function (req, res, next) { 

    // we expect every request to have the form "/api/[api-version]/..." 
    // verify that the api-version is a valid semver value 
    var urlPieces = req.url.replace(/^\/+/, '').split('/'); 
    var api = urlPieces[0]; 
    var apiVersion = urlPieces[1]; 

    if (api !== 'api' || !semver.valid(apiVersion)) { 
     return next(new restify.InvalidContentError({message: "Invalid Version Specifier"})); 
    } 

    req.header('Accept-Version', apiVersion); 
    return next(); 
} 

Auf diese Weise können die restify Routen der Accept-Header-Version überprüfen, da sie von Natur aus tun.

Nebenbei bemerkt: Der semver Teil ist auf diese Antwort wahrscheinlich nicht relevant, aber ich wollte, dass die API-Version in der URL zu überprüfen, ein gültiger semver Wert war, da es Flexibilität in den URL-Werten so ermöglicht, dass ein Benutzer könnte Nutzen Sie die Flexibilität von restify in Versionsspezifizierern.