mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-01-20 22:42:53 -05:00
c02ebb0dcf
closes #2610, refs #2697 - cleanup API index.js, and add docs - all API methods take consistent arguments: object & options - browse, read, destroy take options, edit and add take object and options - the context is passed as part of options, meaning no more .call everywhere - destroy expects an object, rather than an id all the way down to the model layer - route params such as :id, :slug, and :key are passed as an option & used to perform reads, updates and deletes where possible - settings / themes may need work here still - HTTP posts api can find a post by slug - Add API utils for checkData
62 lines
2.5 KiB
JavaScript
62 lines
2.5 KiB
JavaScript
var url = require('url'),
|
|
ApiRouteBase = '/ghost/api/v0.1/',
|
|
host = 'localhost',
|
|
port = '2369',
|
|
schema = 'http://',
|
|
expectedProperties = {
|
|
posts: ['posts', 'meta'],
|
|
users: ['users'],
|
|
pagination: ['page', 'limit', 'pages', 'total', 'next', 'prev'],
|
|
post: ['id', 'uuid', 'title', 'slug', 'markdown', 'html', 'meta_title', 'meta_description',
|
|
'featured', 'image', 'status', 'language', 'created_at', 'created_by', 'updated_at',
|
|
'updated_by', 'published_at', 'published_by', 'page', 'author', 'tags', 'fields'],
|
|
settings: ['settings', 'meta'],
|
|
setting: ['id', 'uuid', 'key', 'value', 'type', 'created_at', 'created_by', 'updated_at', 'updated_by'],
|
|
tag: ['id', 'uuid', 'name', 'slug', 'description', 'parent',
|
|
'meta_title', 'meta_description', 'created_at', 'created_by', 'updated_at', 'updated_by'],
|
|
theme: ['uuid', 'name', 'version', 'active'],
|
|
user: ['id', 'uuid', 'name', 'slug', 'email', 'image', 'cover', 'bio', 'website',
|
|
'location', 'accessibility', 'status', 'language', 'meta_title', 'meta_description', 'last_login',
|
|
'created_at', 'created_by', 'updated_at', 'updated_by'],
|
|
notification: ['type', 'message', 'status', 'id', 'dismissable', 'location']
|
|
};
|
|
|
|
function getApiQuery(route) {
|
|
return url.resolve(ApiRouteBase, route);
|
|
}
|
|
|
|
function getApiURL(route) {
|
|
var baseURL = url.resolve(schema + host + ':' + port, ApiRouteBase);
|
|
return url.resolve(baseURL, route);
|
|
}
|
|
function getSigninURL() {
|
|
return url.resolve(schema + host + ':' + port, 'ghost/signin/');
|
|
}
|
|
function getAdminURL() {
|
|
return url.resolve(schema + host + ':' + port, 'ghost/');
|
|
}
|
|
|
|
// make sure the API only returns expected properties only
|
|
function checkResponseValue(jsonResponse, properties) {
|
|
Object.keys(jsonResponse).length.should.eql(properties.length);
|
|
for (var i = 0; i < properties.length; i = i + 1) {
|
|
// For some reason, settings response objects do not have the 'hasOwnProperty' method
|
|
if (Object.prototype.hasOwnProperty.call(jsonResponse, properties[i])) {
|
|
continue;
|
|
}
|
|
jsonResponse.should.have.property(properties[i]);
|
|
}
|
|
}
|
|
|
|
function checkResponse(jsonResponse, objectType) {
|
|
checkResponseValue(jsonResponse, expectedProperties[objectType]);
|
|
}
|
|
|
|
module.exports = {
|
|
getApiURL: getApiURL,
|
|
getApiQuery: getApiQuery,
|
|
getSigninURL: getSigninURL,
|
|
getAdminURL: getAdminURL,
|
|
checkResponse: checkResponse,
|
|
checkResponseValue: checkResponseValue
|
|
};
|