Fortress REST API - URL and Parameter Documentation?

["Brian Brooks (US)" <Br...@datapath.com>]

Hi Fortress Users,

I'm trying out Fortress REST.  I'm having trouble locating information on the URLs and parameters for the Fortress REST API.  All I see at http://directory.apache.org/fortress/overview.html is a way to run the test "mvn test -Dtest=EmTest".

Did I miss a web page/presentation?

Brian Brooks
Sr Software Engineer
brian.brooks@datapath.com
Office: +1 678 252 4498
2205 Northmont Pkwy, STE 100
Duluth, GA 30096

Re: Fortress REST API - URL and Parameter Documentation?

[Shawn McKinney <sm...@apache.org>]

Hello Brian, welcome!

The REST service APIs are described here:
http://javadoc.io/doc/org.apache.directory.fortress/fortress-rest/1.0.0

You can infer the URLs for each service by this doc.  For example findUser:

combines the overall service name:
@Service(value="fortressService")

with the path name corresponding with a particular method (viewed from javadoc for that service):
 @Path(value="/userSearch/“)

Those two are then combined:
fortressService/userSearch

Beyond that, to figure out which parameters to pass you can look at some of these examples:
https://github.com/apache/directory-fortress-enmasse/tree/master/src/test/resources

For example addUser:
https://github.com/apache/directory-fortress-enmasse/blob/master/src/test/resources/addEmUser1.xml

These examples are called during the junit test, EmTest you asked about.  

Instructions to run that test are here:
https://github.com/apache/directory-fortress-enmasse/blob/master/README.md

Beyond these simple examples, you can drive the rest services via the fortress-core junit tests as described in this section of the readme:
SECTION 7: Alternate testing procedures

Once routing the fortress-core junit tests through fortress-rest server, you could capture the request/responses via a proxy or sniffer to see the signatures for each.

Happy to provide further instructions if you are willing to pursue.  

Thanks,
Shawn

> On May 30, 2017, at 12:43 PM, Brian Brooks (US) <Br...@datapath.com> wrote:
> 
> Hi Fortress Users,
> 
> I'm trying out Fortress REST.  I'm having trouble locating information on the URLs and parameters for the Fortress REST API.  All I see at http://directory.apache.org/fortress/overview.html is a way to run the test "mvn test -Dtest=EmTest".
> 
> Did I miss a web page/presentation?
> 
> Brian Brooks
> Sr Software Engineer
> brian.brooks@datapath.com
> Office: +1 678 252 4498
> 2205 Northmont Pkwy, STE 100
> Duluth, GA 30096
>