W3C home > Mailing lists > Public > public-dwbp-wg@w3.org > May 2016

Re: API BPs Example

From: Annette Greiner <amgreiner@lbl.gov>
Date: Tue, 3 May 2016 11:43:30 -0700
To: public-dwbp-wg@w3.org
Message-ID: <7a321caa-dd00-8745-5a1d-09577ae9e408@lbl.gov>
A few more notes on looking some more at the documentation. You 
shouldn't need to include URL parameters, since the URL itself should 
determine what gets returned.

For example,
/bus/stops     returns the full list
/bus/stops/route/11     returns the list of stops for route 11 only

'transport-agency' is just part of the base URL for the API, so that 
wouldn't be a parameter.
'full details' or not for an API like this seems unnecessary, because 
the difference in size would be so small that it wouldn't matter.
-Annette

On 5/3/16 8:35 AM, Deirdre Lee wrote:
> |Hi,
>
> I've created an example that can be used for the API BPs|
>
>     |Best Practice 21: Provide real-time access |
>     |Best Practice 23: Make data available through an API|
>     |Best Practice 24: Use Web Standards as the foundation of APIs|
>     |Best Practice 25: Provide complete documentation for your API|
>
> |
> https://www.w3.org/2013/dwbp/wiki/Api_example
> |
>
>     |GET /bus/routes|
>     |GET /bus/stops|
>     |GET /bus/realtime|
>     ||
>
> |
> For 'GET /bus/stops', I've used three different ways to describe 
> bus-stops:
> |
>
>   * |using simple fields, |
>   * |using fields defined in
>     http://w3c.github.io/dwbp/dwbp-example.html and |
>   * |using geojson to describe lat/long.|
>
> |We should pick one approach. I think the third - simple fields and 
> geojson.
> |
>
> |What do you think?
> |
>
> |Cheers,
> Deirdre
> |
>
> -- 
> ------------------------------------
> Deirdre Lee, CEO & Founder
> Derilinx - Linked & Open Data Solutions
>   
> Web:www.derilinx.com
> Email:deirdre@derilinx.com
> Address:  11/12 Baggot Court, Dublin 2, D02 F891
> Tel:      +353 (0)1 254 4316
> Mob:      +353 (0)87 417 2318
> Linkedin: ie.linkedin.com/in/leedeirdre/
> Twitter:  @deirdrelee

-- 
Annette Greiner
NERSC Data and Analytics Services
Lawrence Berkeley National Laboratory
Received on Tuesday, 3 May 2016 18:43:57 UTC

This archive was generated by hypermail 2.3.1 : Tuesday, 3 May 2016 18:43:57 UTC