rebirth http

@ng-zorro/rebirth-http

Java JPA-подобный HTTP-клиент для Angular.

? Установка

$ npm install @ng-zorro/rebirth-http --save

? Использование

Шаг 1. Зарегистрируйте RebirthHttpModule

 import { RebirthHttpModule } from '@ng-zorro/rebirth-http' ;

@ NgModule ( {
  imports : [ BrowserModule , RebirthHttpModule ] ,
  declarations : [ AppComponent ] ,
  bootstrap : [ AppComponent ] ,
} )
export class AppModule { }

Шаг 2. Создание клиентов REST

 import {
  Any ,
  RebirthHttpClient ,
  JSONP ,
  GET ,
  POST ,
  PUT ,
  DELETE ,
  PATCH ,
  BaseUrl ,
  Query ,
  Path ,
  Body ,
} from 'rebirth-http' ;
import { Observable } from 'rxjs/Observable' ;
import { HttpClient } from '@angular/common/http' ;

@ Injectable ( )
export class ArticleService extends RebirthHttpClient {
  constructor ( http : HttpClient ) {
    super ( http ) ;
  }

  @ GET ( 'article' )
  getArticles (
    @ Query ( 'pageIndex' ) pageIndex = 1 ,
    @ Query ( 'pageSize' ) pageSize = 10
  ) : Observable < SearchResult < Article > > {
    return Any ; // return Any as a placeholder
  }

  @ GET ( 'article/:id' )
  getArticleByUrl ( @ Path ( 'id' ) articleUrl : string ) : Observable < Article > {
    return Any ;
  }

  @ POST ( 'article' )
  createArticle ( @ Body article : Article ) : Observable {
    return Any ;
  }

  @ PUT ( 'article/:id' )
  updateArticle (
    @ Path ( 'id' ) id : string ,
    @ Body article : Article
  ) : Observable < Article > {
    return Any ;
  }

  @ DELETE ( 'article/:id' )
  deleteArticleById ( @ Path ( 'id' ) id : string ) : Observable < Article > {
    return Any ;
  }

  @ JSONP ( 'article/:id' )
  getArticleByJsonp (
    @ Path ( 'id' ) id : string ,
    @ Query ( 'name' ) name : string
  ) : Observable < Article > {
    return Any ;
  }

  @ POST ( 'file/upload' )
  upload ( @ Body formData : FormData ) : Observable < any > {
    return Any ;
  }
}

Шаг 3. Вызовите ArticleService

Теперь вы можете вызывать методы ArticleService для запуска HTTP-запросов! :)

Перехватчик

Вы можете добавить перехватчики для любого RebirthHttpClient .

 import { config } from '@/config' ;
import { RebirthHttpProvider } from '@ng-zorro/rebirth-http' ;

@ Component ( {
  selector : 'app-root' ,
} )
export class AppComponent {
  constructor ( rebirthHttpProvider : RebirthHttpProvider ) {
    rebirthHttpProvider . baseUrl ( config . api . host ) . addInterceptor ( {
      request : ( request ) =>
        console . log ( 'Global interceptors(request)' , request ) ,
      response : ( response ) =>
        console . log ( 'Global interceptors(response)' , response ) ,
    } ) ;
  }
} 

API

RebirthHttpClient

Каждая служба, отвечающая за HTTP, должна наследовать RebirthHttpClient .

• getBaseUrl(): string : возвращает базовый URL-адрес клиента RebirthHttp.
• getDefaultHeaders(): { [name: string]: string } : возвращает заголовки RebirthHttp по умолчанию в паре ключ-значение.

Декораторы классов

Эти декораторы следует использовать в классах, наследующих RebirthHttpClient .

• @BaseUrl(url: string) : изменить базовый URL-адрес RebirthHttpClient.
• @DefaultHeaders(headers: Object) : изменить заголовок по умолчанию RebirthHttpClient.

Декораторы методов

Декораторы HTTP-метода

Эти декораторы сделают методы RebirthHttpClient способными отправлять HTTP-запросы.

• @GET(url: string)
• @POST(url: string)
• @PUT(url: string)
• @DELETE(url: string)
• @JSONP(url: string)
• @PATCH(url: string)
• @HEAD(url: string)
• @OPTIONS(url: String)

Вы можете использовать декораторы ниже, чтобы изменить параметры HTTP.

• @Headers(headers: any)
• @RequestOptions(headers: any)
• @Extra(headers: any)

Декораторы параметров

Используйте декораторы ниже, чтобы украсить параметры методов RebirthHttpClient , чтобы параметр стал соответствующими опциями HTTP.

• @Path(key: string)
• @Query(key: string)
• @Header(key: string)
• @Body

Кредит

Спасибо Paldom/angular2-rest, вдохновившему нас.

☀️ Лицензия

Массачусетский технологический институт