API-Entwicklung bei XING

API-Entwicklung bei XING Mark Schmidt

XING?Bestehende APIsSchritte zu einer guten API

Technologie-Department

rdwareHa

Software

Bestehende APIs

Interne APIs:

YAML HTTP API / Perl Backend

Gearman

gemeinsam genutzte Datenbanken

AMQP / RabbitMQ

REST-APIs

Externe APIs:

SOAP-Schnittstelle für Payment

(+ kleine Insellösungen)

das (externe) API-Team

Schritte zu einer guten API Schritte zu einer guten API

Warum ist API-Design wichtig?

Gute API?→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Einfach zu erlernen→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Einfach zu benutzen, auch ohne Dokumentation→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Lässt sich nur schwer falsch benutzen→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Client-Code ist gut les- und wartbar→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Ausreichend mächtig→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Einfach zu erweitern→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Geeignet für die Zielgruppe→ J.Bloch, How to Design a Good API and Why it Matters, 2006

Probleme... Fragen... Lösungen?

REpresentationalStateTransfer!→ R. Fielding, Architectural Styles and the Design of Network-based Software Architectures , 2000

Response-Format

GET https://api.xing.com/v1/users/123456_abcdef/contacts/upcoming_birthdays?limit=3&offset=0 { "upcoming_birthdays": { "total": 34, "items": [{ "user": {"id": "52313245_52f7g0"}, "day": 20, "month": 10, "year": 1980 }, { "user": {"id": "78787878_12h4g2"}, "day": 22, "month": 10, "year": 1965 }, { "user": {"id": "3453245_h190cx"}, "day": 23, "month": 10, "year": null }] } }

Status-Codes

200, 201, 204

400, 401, 403, 404, 405

(500, ) 503

∀ > 400 : {JSON,XML}

{ "error_name": "INVALID_OAUTH_TOKEN", "message": "Invalid OAuth token", "revoke_reason": "PASSWORD_CHANGED"}

API-Domäne != Produkt-Domäne

intern: Module namespace/rest/newsfeed/activitystream/:user_idREST API namespace Module Resourcesextern:/v1/users/:user_id/network_feed

Versionierung

GET api.xing.com/users/123?version=1 vs. GET api.xing.com/v1/users/123 vs. GET api.xing.com/users/123Accept: application/vnd.xing.user-v1+json

Hinzufügen neuer Calls? Kein Problem, aber...

Call-Lifecycle

Eingabe ⤻ Ausgabe

module WebService class CommentsController < WebService::ServiceController add_call :name => Get comments of an activity, :description => "Returns a list of all comments which have been made for an activity.", :status => :experimental, :experimental_since => 2011-05-02, :action => index, :permission => :activity_stream, :required_parameters => { "activity_id" => "Activity ID" }, :optional_parameters => { limit => "How many comments to return. Must be a positive number. Default: 10", "offset" => "Offset. Must be a positive number. Default: 0", "user_fields" => "Comma separated list of user attributes to return..." }, :returns => { :success => {:code => 200, :message => The call was completed successfully}, :invalid_parameters => {:code => 403, :message => ..., :error => INVALID_PARAMETERS}, :access_denied => {:code => 403, :message => ..., :error => ACCESS_DENIED}, :activity_not_found => {:code => 404, :message => ..., :error => ACTIVITY_NOT_FOUND} }, :response_example => "..." endend

module WebService::Handlers class CommentsHandler < WebService::Handlers::Base include WebService::Handlers::Helpers def index(params) activity = find_activity!(params[:activity_id], :rid => User.current.id) limit, offset = pagination_params!(params[:limit], params[:offset]) result = { :comments => [] } if activity[:comments].any? && activity[:comments].size > offset user_fields = filter_user_fields(params[:user_fields]) result[:comments] = ActivityStream::Comment.build(activity[:comments], :user_fields => user_fields)[offset, limit] end result rescue ResourceNotFoundError :activity_not_found rescue InvalidParameterError => e [:invalid_parameters, {:message => e.message}] rescue AccessDeniedError :access_denied end endend

Oauth für Partnerintegrationen?

Wie geht‘s weiter?

Noch 2 Punkte in eigener Sache:

api@xing.com

Product Owner Ruby Developer Perl DeveloperQuality Assurance Manager Frontend Developer Interaction Designer ... XING sucht neue Kollegen!

API-Entwicklung bei XING

by Mark Schmidt

Accessibility

Categories

Upload Details

Usage Rights

1 Embed 3

Statistics

API-Entwicklung bei XING Presentation Transcript