librelist archives

« back to archive

Start of a hypermedia API

Start of a hypermedia API

From:
Carol Nichols
Date:
2012-05-20 @ 20:08
Hi everyone,

You may have noticed a few commits I've made lately having to do with an
ALPS spec-- it's an experimental hypermedia API spec format, this one in
particular [1] is for microblogging, that just consists of rels, classes,
ids, and names that the server provides and the client looks for.

I've been reading Steve's not-a-book [2] and found this approach appealing
to try out with rstat.us. Mostly because it just meant we would have to add
these attributes in to our existing HTML and because I had to do some web
scraping for a previous job and sites that seemed to follow schemas like
this were the easiest to scrape.

And because it's easiest to discuss these types of things when there's
actual code, I added enough of the ALPS spec to rstat.us to enable
unauthenticated reading of statuses [3], and I extended Steve's example
Shoes client [4] into one a little more fuller-featured [5] that supports
rstat.us as well as the default example server. There are instructions on
how to use it in the README.

So I'm not suggesting that this shoes client be a real client for rstat.us,
but I am looking for feedback from any of you on this list who may want to
write clients using an rstat.us API. Mainly:

- What do you think of hypermedia APIs in general?
- Do you think a hypermedia API is a good fit for rstat.us? Why or why not?
- Would you write a client for rstat.us if this was the first API that was
fully supported? Why or why not?

Any feedback would be awesome!!!

[1] - http://amundsen.com/hypermedia/profiles/
[2] - http://designinghypermediaapis.com/
[3] - https://github.com/hotsh/rstat.us/compare/bba0d706b6...ba3882056c
[4] - https://gist.github.com/2187514
[5] - https://github.com/clnclarinet/shoes-alps-client

-Carol

Re: [rstatus] Start of a hypermedia API

From:
Mark Kremer
Date:
2012-05-31 @ 08:10
Hi Carol,

Sorry for not replying sooner, I hadn't had the chance to properly read 
your mail yet.

I don't know enough about hypermedia APIs to have a proper opinion, I 
like the general idea though.

Regards,
Mark

On 05/20/2012 10:08 PM, Carol Nichols wrote:
> Hi everyone,
>
> You may have noticed a few commits I've made lately having to do with 
> an ALPS spec-- it's an experimental hypermedia API spec format, this 
> one in particular [1] is for microblogging, that just consists of 
> rels, classes, ids, and names that the server provides and the client 
> looks for.
>
> I've been reading Steve's not-a-book [2] and found this approach 
> appealing to try out with rstat.us <http://rstat.us>. Mostly because 
> it just meant we would have to add these attributes in to our existing 
> HTML and because I had to do some web scraping for a previous job and 
> sites that seemed to follow schemas like this were the easiest to scrape.
>
> And because it's easiest to discuss these types of things when there's 
> actual code, I added enough of the ALPS spec to rstat.us 
> <http://rstat.us> to enable unauthenticated reading of statuses [3], 
> and I extended Steve's example Shoes client [4] into one a little more 
> fuller-featured [5] that supports rstat.us <http://rstat.us> as well 
> as the default example server. There are instructions on how to use it 
> in the README.
>
> So I'm not suggesting that this shoes client be a real client for 
> rstat.us <http://rstat.us>, but I am looking for feedback from any of 
> you on this list who may want to write clients using an rstat.us 
> <http://rstat.us> API. Mainly:
>
> - What do you think of hypermedia APIs in general?
> - Do you think a hypermedia API is a good fit for rstat.us 
> <http://rstat.us>? Why or why not?
> - Would you write a client for rstat.us <http://rstat.us> if this was 
> the first API that was fully supported? Why or why not?
>
> Any feedback would be awesome!!!
>
> [1] - http://amundsen.com/hypermedia/profiles/
> [2] - http://designinghypermediaapis.com/
> [3] - https://github.com/hotsh/rstat.us/compare/bba0d706b6...ba3882056c
> [4] - https://gist.github.com/2187514
> [5] - https://github.com/clnclarinet/shoes-alps-client
>
> -Carol

Re: [rstatus] Start of a hypermedia API

From:
Colin Dean
Date:
2012-05-22 @ 13:20
I think it's a worthwhile effort. A major point of Hypermedia APIs is to 
minimize extra code for a separate api, right? This does that and that's 
awesome. 

Carol Nichols <carol.nichols@gmail.com> wrote:

Hi everyone,

You may have noticed a few commits I've made lately having to do with an 
ALPS spec-- it's an experimental hypermedia API spec format, this one in 
particular [1] is for microblogging, that just consists of rels, classes, 
ids, and names that the server provides and the client looks for.

I've been reading Steve's not-a-book [2] and found this approach appealing
to try out with rstat.us. Mostly because it just meant we would have to 
add these attributes in to our existing HTML and because I had to do some 
web scraping for a previous job and sites that seemed to follow schemas 
like this were the easiest to scrape.

And because it's easiest to discuss these types of things when there's 
actual code, I added enough of the ALPS spec to rstat.us to enable 
unauthenticated reading of statuses [3], and I extended Steve's example 
Shoes client [4] into one a little more fuller-featured [5] that supports 
rstat.us as well as the default example server. There are instructions on 
how to use it in the README.

So I'm not suggesting that this shoes client be a real client for 
rstat.us, but I am looking for feedback from any of you on this list who 
may want to write clients using an rstat.us API. Mainly:

- What do you think of hypermedia APIs in general? 
- Do you think a hypermedia API is a good fit for rstat.us? Why or why not?
- Would you write a client for rstat.us if this was the first API that was
fully supported? Why or why not?

Any feedback would be awesome!!!

[1] - http://amundsen.com/hypermedia/profiles/
[2] - http://designinghypermediaapis.com/
[3] - https://github.com/hotsh/rstat.us/compare/bba0d706b6...ba3882056c
[4] - https://gist.github.com/2187514
[5] - https://github.com/clnclarinet/shoes-alps-client

-Carol