Java 类retrofit.http.Path 实例源码

@GET("/v1.0/me/mailfolders/{folderid}/messages")
Response getMessages(
  @Path("folderid") String folderId,
  @Query("$orderby") String orderBy,
  @Query("$select") String select,
  @Query("$filter") String filter,
  @Query("$top") Integer maxResults
);

/**
 * Returns all top level comments for an episode. Most recent comments returned first.
 *
 * @param showId trakt ID, trakt slug, or IMDB ID. Example: "game-of-thrones".
 * @param season Season number.
 * @param episode Episode number.
 */
@GET("/shows/{id}/seasons/{season}/episodes/{episode}/comments")
List<Comment> comments(
        @Path("id") String showId,
        @Path("season") int season,
        @Path("episode") int episode,
        @Query("page") Integer page,
        @Query("limit") Integer limit,
        @EncodedQuery("extended") Extended extended
);

/**
 * <b>OAuth Optional</b>
 *
 * <p> Get all items on a custom list. Items can be movies, shows, seasons, episodes, or people.
 */
@GET("/users/{username}/lists/{id}/items")
List<ListEntry> listItems(
        @Path("username") String username,
        @Path("id") String id,
        @EncodedQuery("extended") Extended extended
) throws OAuthUnauthorizedException;

@GET("/item/{id}.json")
Observable<Item> getItem(@Path("id") int id);

@GET("/jokes/{id}")
Observable<ItemResponse> getItem(@Query("firstName") String firstName, @Query("lastName") String lastName, @Path("id") int id);

/**
 * Returns a single movie's details.
 *
 * @param movieId trakt ID, trakt slug, or IMDB ID. Example: "tron-legacy-2010".
 */
@GET("/movies/{id}")
Movie summary(
        @Path("id") String movieId,
        @EncodedQuery("extended") Extended extended
);

@GET("/{id_station}")
void getStationInfo(@Path("id_station") String idStation, Callback<StationResponse> callback);

@FormUrlEncoded
@POST("/{tenantid}/oauth2/v2.0/token")
Response getAccessTokenFromAuthCode(
  @Path("tenantid") String tenantId,
  @Field("client_id") String clientId,
  @Field("client_secret") String clientSecret,
  @Field("grant_type") String grantType,
  @Field("code") String code,
  @Field("redirect_uri") String redirectUrl
);

@FormUrlEncoded
@POST("/{tenantid}/oauth2/v2.0/token")
Response getAccessTokenFromRefreshToken(
  @Path("tenantid") String tenantId,
  @Field("client_id") String clientId,
  @Field("client_secret") String clientSecret,
  @Field("grant_type") String grantType,
  @Field("refresh_token") String code,
  @Field("redirect_uri") String redirectUrl
);

@GET("/v1.0/me/mailfolders/{folderid}")
Response getFolder(
  @Path("folderid") String folderId
);

@GET("/v1/devices/{deviceID}/{variable}")
ReadObjectVariableResponse getVariable(@Path("deviceID") String deviceID,
                                       @Path("variable") String variable);

@GET("/v1/devices/{deviceID}/{variable}")
ReadStringVariableResponse getStringVariable(@Path("deviceID") String deviceID,
                                             @Path("variable") String variable);

/**
 * Returns all top level comments for a movie. Most recent comments returned first.
 *
 * @param movieId trakt ID, trakt slug, or IMDB ID. Example: "tron-legacy-2010".
 * @param page Number of page of results to be returned. If {@code null} defaults to 1.
 * @param limit Number of results to return per page. If {@code null} defaults to 10.
 */
@GET("/movies/{id}/comments")
List<Comment> comments(
        @Path("id") String movieId,
        @Query("page") Integer page,
        @Query("limit") Integer limit,
        @EncodedQuery("extended") Extended extended
);

@GET(USER_GET_CONTACTS_PENDING_SVC)
public Collection<MobileClient> getContactsPending(@Path(USER_ID) long userId);

/**
 * <b>OAuth Required</b>
 *
 * <p> Add one or more items to a custom list. Items can be movies, shows, seasons, episodes, or people.
 */
@POST("/users/{username}/lists/{id}/items")
SyncResponse addListItems(
        @Path("username") String username,
        @Path("id") String id,
        @Body SyncItems items
) throws OAuthUnauthorizedException;

@GET(USER_GET_CONTACTS_ACCEPTED_SVC)
public Collection<MobileClient> getContactsAccepted(@Path(USER_ID) long userId);

/**
 * Returns a single person's details.
 *
 * @param personId trakt ID, trakt slug, or IMDB ID Example: bryan-cranston.
 */
@GET("/people/{id}")
Person summary(
        @Path("id") String personId,
        @Query("extended") Extended extended
);

@GET("/people/{id}/movies")
Credits movieCredits(
        @Path("id") String personId
);

/**
 * Returns a single episode's details.
 *
 * @param showId trakt ID, trakt slug, or IMDB ID. Example: "game-of-thrones".
 * @param season Season number.
 * @param episode Episode number.
 */
@GET("/shows/{id}/seasons/{season}/episodes/{episode}")
Episode summary(
        @Path("id") String showId,
        @Path("season") int season,
        @Path("episode") int episode,
        @EncodedQuery("extended") Extended extended
);

/**
 * <b>OAuth Required</b>
 *
 * <p> Remove a custom list and all items it contains.
 */
@DELETE("/users/{username}/lists/{id}")
Response deleteList(
        @Path("username") String username,
        @Path("id") String id
) throws OAuthUnauthorizedException;

@GET("/jokes/{id}")
Observable<ItemResponse> getItem(@Query("firstName") String firstName, @Query("lastName") String lastName, @Path("id") int id);

@PUT("/collectors/{collectorId}")
Response register(@Path("collectorId") String collectorId, @Body CollectorRegistrationRequest request);

@PUT("/system/collectors/{collectorId}")
Response legacyRegister(@Path("collectorId") String collectorId, @Body CollectorRegistrationRequest request);

@Headers("Content-Type: application/json")
@PUT("/notifications/{id}/") void openedOneSignalPush(@Path("id") String id, @Body OneSignalBody data, Callback<OneSignalResponse> response);

@GET("/v1/devices/{deviceID}")
Models.CompleteDevice getDevice(@Path("deviceID") String deviceID);

@FormUrlEncoded
@PUT("/v1/devices/{deviceID}")
Response nameDevice(@Path("deviceID") String deviceID,
                    @Field("name") String name);

@POST("/v1/devices/{deviceID}/{function}")
CallFunctionResponse callFunction(@Path("deviceID") String deviceID,
                                  @Path("function") String function,
                                  @Body FunctionArgs args);

@GET("/v1/devices/{deviceID}/{variable}")
ReadIntVariableResponse getIntVariable(@Path("deviceID") String deviceID,
                                       @Path("variable") String variable);

@FormUrlEncoded
@POST("/v1/orgs/{orgSlug}/products/{productSlug}/device_claims")
ClaimCodeResponse generateClaimCodeForOrg(@Field("blank") String blankBody,
                                          @Path("orgSlug") String orgSlug,
                                          @Path("productSlug") String productSlug);

@DELETE("/v1/devices/{deviceID}")
SimpleResponse unclaimDevice(@Path("deviceID") String deviceID);

@POST(SUB_SUBSCRIBE_SVC)
RequestSubscriptionResult doSubscriptionByUsername(
        @Path(SUBSCRIBER_ID) long subId, @Body String pubUsername);

@POST(PUB_REVOKE_SVC)
boolean revokeSubscription(
        @Path(PUBLISHER_ID) long pubId, @Body long subId);

@POST(PUB_ALERT_SVC)
boolean notifyAlert(
        @Path(PUBLISHER_ID) long pubId, @Body GlucoseAlert glucose);

@POST(SUB_SUBSCRIBE_SVC)
RequestSubscriptionResult doSubscriptionByUsername(
        @Path(SUBSCRIBER_ID) long subId,
        @Body String pubUsername,
        HttpServletResponse response);

@POST(PUB_CONFIRM_SVC)
boolean confirmSubscription(
        @Path(PUBLISHER_ID) long pubId,
        @Body SubscriptionResult subscriptionResult,
        HttpServletResponse response);

@POST(PUB_REVOKE_SVC)
boolean revokeSubscription(
        @Path(PUBLISHER_ID) long pubId,
        @Body long subId,
        HttpServletResponse response);

@POST(PUB_ALERT_SVC)
boolean notifyAlert(
        @Path(PUBLISHER_ID) long pubId,
        @Body GlucoseAlert glucoseAlert,
        HttpServletResponse response);

@GET("/jokes/random/{number}?limitTo=[nerdy]")
JokeResponse getRandomJokesSync(@Path("number") int numberOfJokes);

@GET("/jokes/random/{number}?limitTo=[nerdy]")
void getRandomJokesAsync(@Path("number") int numberOfJokes, Callback<JokeResponse> callback);

/**
 * Returns all seasons for a show including the number of episodes in each season.
 *
 * @param showId trakt ID, trakt slug, or IMDB ID. Example: "game-of-thrones".
 */
@GET("/shows/{id}/seasons")
List<Season> summary(
        @Path("id") String showId,
        @EncodedQuery("extended") Extended extended
);