Commit cf84d586 authored by Dave Lawrence's avatar Dave Lawrence

Bug 958057 - REST API - No example of non-rewrite endpoint in POD docs, no…

Bug 958057 - REST API - No example of non-rewrite endpoint in POD docs, no config directions for how to create rewrite r/a=justdave
parent e117d6b8
...@@ -504,11 +504,21 @@ C<Bugzilla::WebService::Server::XMLRPC|XML-RPC> interface. ...@@ -504,11 +504,21 @@ C<Bugzilla::WebService::Server::XMLRPC|XML-RPC> interface.
=head1 CONNECTING =head1 CONNECTING
The endpoint for the REST interface is the C<rest.cgi> script in The endpoint for the REST interface is the C<rest.cgi> script in
your Bugzilla installation. If using Apache and mod_rewrite is installed your Bugzilla installation. For example, if your Bugzilla is at
and enabled, you can also use /rest/ as your endpoint. For example, if your C<bugzilla.yourdomain.com>, to access the API and load a bug,
Bugzilla is at C<bugzilla.yourdomain.com>, then your REST client would you would use C<http://bugzilla.yourdomain.com/rest.cgi/bug/35>.
access the API via: C<http://bugzilla.yourdomain.com/rest/bug/35> which
looks cleaner. If using Apache and mod_rewrite is installed and enabled, you can
simplify the endpoint by changing /rest.cgi/ to something like /rest/
or something similar. So the same example from above would be:
C<http://bugzilla.yourdomain.com/rest/bug/35> which is simpler to remember.
Add this to your .htaccess file:
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteRule ^rest/(.*)$ rest.cgi/$1 [NE]
</IfModule>
=head1 BROWSING =head1 BROWSING
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment