topic Have you tried the new v1 REST APIs yet ? in Alfresco Archive

Have you tried the new v1 REST APIs yet ?

janv — Fri, 04 Nov 2016 16:27:01 GMT

You may have noticed that Gavin Cornwell has started a great blog post series on getting started with the new v1 REST APIs (ten parts so far). Ole Hejlskov has also recorded a short video to introduce the REST APIS. All the links are now available here Alfresco public REST APIs Have you had a chance

Re: Have you tried the new v1 REST APIs yet ?

jego — Sun, 06 Nov 2016 20:40:39 GMT

Jan,

the link does not work for me.

The following link works for me:

Alfresco Community Edition - Nightly builds

Re: Have you tried the new v1 REST APIs yet ?

jego — Sun, 06 Nov 2016 21:59:49 GMT

Hi Jan,

can I have a list of endpoints (without installing the api-explorer)??

The web script home does not list the new endpoints, correct?

BTW, I does not understand the response scheme sometimes. Why are you wrapping the values of an entry into an additional object entry within the entries array of objects?

Re: Have you tried the new v1 REST APIs yet ?

janv — Mon, 07 Nov 2016 11:37:13 GMT

Hi Jens,

I've updated the link as suggested, thanks

You're right that the v1 REST API endpoints do not appear as part of the web scripts index. Ideally, you should deploy the matching api-explorer.war. You can also access the OpenAPI (swagger) definitions here: rest-api-explorer/src/main/webapp/definitions at community-head · Alfresco/rest-api-explorer · GitHub

Otherwise, you can also use OPTIONS to list methods for each of the entity names, such as: /nodes, /sites, /people, ... etc. For example:

curl -umyuserid:mypassword -X OPTIONS http://localhost:8085/alfresco/api/-default-/public/alfresco/versions/1/nodes

Yes, the extra "entry" is a little odd. This was inherited as part of the original v1 REST API design (for 4.2 to 5.1) but we didn't want to introduce any breaking api changes, at least not for the foreseeable future. Ultimately, if we were to ever introduce v2 REST API (no current plans) then we would likely remove this extra level.

Thanks for the feedback so far.

Regards,

Jan

Re: Have you tried the new v1 REST APIs yet ?

janv — Thu, 24 Nov 2016 18:25:54 GMT

Thanks for your feedback so far via the various channels, including here, on the blogs posts and in JIRA.

I have also updated the original question to reference Community 201611 EA and also added links to new blog posts.

Regards,

Jan