wordpress-clients/wp-api-angularPublic

NotificationsYou must be signed in to change notification settings
Fork82
Star260

Angular (>=2) services for WordPress WP-API(v2) or WP >= 4.7 (natively supports WP-API)

License

View license

260 stars 82 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 109 Commits
demo		demo
src		src
typings		typings
.editorconfig		.editorconfig
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
Copyright.txt		Copyright.txt
LICENSE		LICENSE
README.md		README.md
config.dist.json		config.dist.json
package.json		package.json
tsconfig.demo.json		tsconfig.demo.json
tsconfig.json		tsconfig.json
typings.json		typings.json
webpack.config.dist.js		webpack.config.dist.js
webpack.config.js		webpack.config.js
yarn.lock		yarn.lock

Repository files navigation

wp-api-angular

Angular >=2 services for WordPress >= 4.7 Rest API

================

Angular2 services to consumeWP-API v2

Live Demo

If you want to use AngularJS v1, here is the latest version:v2.0.0-rc3.npm i wp-api-angularjs@v2.0.0-rc3

Installation

npm install -g typingsnpm install wp-api-angular

TypeScript

Nothing special if you use TS

UMD

UMD files are availablewp-api-angular.umd.js andwp-api-angular.umd.min.js, theLive Demo uses them with systemJS

Bootstrap

An exported functionWpApiLoaderFactory is mandatory to be used withAoT compilation orIonic 2.

import{Http}from'@angular/http';import{WpApiModule,WpApiLoader,WpApiStaticLoader}from'wp-api-angular'exportfunctionWpApiLoaderFactory(http:Http){returnnewWpApiStaticLoader(http,'http://YOUR_DOMAIN/wp-json/',/* namespace is optional, default: '/wp/v2' */);}@NgModule({imports:[BrowserModule,WpApiModule.forRoot({provide:WpApiLoader,useFactory:(WpApiLoaderFactory),deps:[Http]})],bootstrap:[App]})exportclassAppModule{}

API

Every method return an Obervable. If you want to get a Promise you will need to add the rxjstoPromise operator:

import'rxjs/add/operator/toPromise';classTest{constructor(privatewpApiPosts:WpApiPosts){this.wpApiPosts.getList().toPromise().then(response=>response.json()).then(body=>{}).catch(error=>{})}}

RequestOptionsArgs

Every request can have an optionalRequestOptionsArgs object.

classRequestOptionsArgs{url :stringmethod :string|RequestMethodsearch :string|URLSearchParamsheaders :Headersbody :anywithCredentials :boolean}

This is where you can add query string to your request or change the headers (see below).

import { Headers } from '@angular/http';const headers = new Headers({  'Content-Type': 'application/json;charset=UTF-8',  'Access-Control-Allow-Origin': '*',  'Access-Control-Max-Age': '1728000',  'Access-Control-Allow-Headers': 'Content-Type, Content-Range, Content-Disposition, Content-Description'  'Access-Control-Allow-Methods': 'DELETE, HEAD, GET, OPTIONS, POST, PUT'});wpApiPosts.getList({ headers });

WpApiPosts

getList(options?:RequestOptionsArgs):Observable<Response>;get(postId,options?:RequestOptionsArgs):Observable<Response>;create(body: any,options?:RequestOptionsArgs):Observable<Response>;update(postId,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(postId,options?:RequestOptionsArgs):Observable<Response>;getMetaList(postId,options?:RequestOptionsArgs):Observable<Response>;getMeta(postId,metaId,options?:RequestOptionsArgs):Observable<Response>;getRevisionList(postId,options?:RequestOptionsArgs):Observable<Response>;getRevision(postId,revisionId,options?:RequestOptionsArgs):Observable<Response>;getCategoryList(postId,options?:RequestOptionsArgs):Observable<Response>;getCategory(postId,categoryId,options?:RequestOptionsArgs):Observable<Response>;getTagList(postId,options?:RequestOptionsArgs):Observable<Response>;getTag(postId,tagId,options?:RequestOptionsArgs):Observable<Response>;

WpApiPages

getList(options?:RequestOptionsArgs):Observable<Response>;get(pageId:number,options?:RequestOptionsArgs):Observable<Response>;create(body: any,options?:RequestOptionsArgs):Observable<Response>;update(pageId:number,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(pageId:number,options?:RequestOptionsArgs):Observable<Response>;getMetaList(pageId:number,options?:RequestOptionsArgs):Observable<Response>;getMeta(pageId:number,metaId:number,options?:RequestOptionsArgs):Observable<Response>;getRevisionList(pageId:number,options?:RequestOptionsArgs):Observable<Response>;getRevision(pageId:number,revisionId: number,options?:RequestOptionsArgs):Observable<Response>;

WpApiComments

getList(options?:RequestOptionsArgs):Observable<Response>;get(commentId: number,options?:RequestOptionsArgs):Observable<Response>;create(body: any,options?:RequestOptionsArgs):Observable<Response>;update(commentId: number,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(commentId:number,options?:RequestOptionsArgs):Observable<Response>;

WpApiTypes

getList(options?:RequestOptionsArgs):Observable<Response>;get(postType: string,options?:RequestOptionsArgs):Observable<Response>;

WpApiMedia

getList(options?:RequestOptionsArgs):Observable<Response>;get(mediaId: number,options?:RequestOptionsArgs):Observable<Response>;create(body: any,options?:RequestOptionsArgs):Observable<Response>;update(mediaId: number,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(mediaId:number,options?:RequestOptionsArgs):Observable<Response>;

WpApiUsers

getList(options?:RequestOptionsArgs):Observable<Response>;me(options?:RequestOptionsArgs):Observable<Response>;get(userId:number,options?:RequestOptionsArgs):Observable<Response>;create(body: any,options?:RequestOptionsArgs):Observable<Response>;update(userId:number,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(userId:number,options?:RequestOptionsArgs):Observable<Response>;

WpApiTaxonomies

getList(options?:RequestOptionsArgs):Observable<Response>;get(taxonomiesType: string,options?:RequestOptionsArgs):Observable<Response>;

WpApiStatuses

getList(options?:RequestOptionsArgs):Observable<Response>;get(statusesName: string,options?:RequestOptionsArgs):Observable<Response>;

WpApiTerms

taxonomiesType can betags,categories and more.

getList(taxonomiesType: string,options?:RequestOptionsArgs):Observable<Response>;get(taxonomiesType: string,termId:number,options?:RequestOptionsArgs):Observable<Response>;create(taxonomiesType: string,body: any,options?:RequestOptionsArgs):Observable<Response>;update(taxonomiesType: string,termId:number,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(taxonomiesType:string,termId:number,options?:RequestOptionsArgs):Observable<Response>;

WpApiCustom

getList(options?:RequestOptionsArgs):Observable<Response>;get(customId: number,options?:RequestOptionsArgs):Observable<Response>;create(body: any,options?:RequestOptionsArgs):Observable<Response>;update(customId: number,body: any,options?:RequestOptionsArgs):Observable<Response>;delete(customId:number,options?:RequestOptionsArgs):Observable<Response>;

Authentication

TO BE DEFINED

Contribute

npm installcp config.dist.json config.json# Open two terminals# and run watch to build on the lib files changesnpm run watch# in the other terminal run following to build the test pagenpm start

Openhttp://localhost:8080