<div>
Also, how is security implemented? Is there a way to send a key or something to ensure that whoever is accessing the API has permission?
</div>

<div>
In REST data and functionality are considered resources and are accessed using Uniform Resource Identifiers (URIs). The resources are acted upon by using a set of simple, well-defined operations. GET &nbsp; &nbsp;/user-management/devices : Get all user POST &nbsp; &nbsp;/user-management/devices : Create a new user GET &nbsp; &nbsp;/user-management/devices/{id} : Get the user information identified by "id" PUT &nbsp; &nbsp;/user-management/devices/{id} : Update the user information identified by "id" DELETE &nbsp; /user-management/devices/{id} : Delete user by "id" repsective http method with equivalent URI makes ur HTTP API.. If you are looking for microservices architecture these are the best bet. Let say you have ecomm applicaiton you can break down applicaiton in to small mirco services like :Inventory, Payment, order, reviews etc Each service can be developed and exposed as Rest API , tomorrow if you want to change or modify service, Just create new one and point to that . API manager is best way handle your APIs, check for some thing like Taffy .. CF API manager. Regarding security , First we need to understand Authentication and Authorization Authentication happens one and next is Autherization for each request. So it depends which model you want to Authenticate and then Auhorize request there after. May be Client ID with secret keys to generate a token after sucessfull Authentication, This token can be passed in each request payload &nbsp;there after for authorization. You can also check Oauth and JWT tokens for the same. -Sri 
</div>

<div>
I am using Lucee so I don't have access to the Coldfusion API manager
</div>

<div>
check this out ..&nbsp;<a href="https://taffy.io/" rel="ugc">https://taffy.io/</a>&nbsp;
</div>

<div>
I am trying to use Taffy and I suspect I don't have it configured correctly on my local machine. I am trying to follow the directions found at: <a href="http://docs.taffy.io/3.2.0#getting-started-with-more-details" rel="ugc">Taffy</a> I downloaded the zip file and unzipped the contents into a directory called taffy which is a subdirectory of my root directory. I created a sibling directory called api and this directory contains an empty index.cfm and an application.cfc. See below for the application.cfc file. <pre><code class="code-10 nolinks" id="code-20-43121519-1">component
extends="taffy.core.api"
{

&nbsp; &nbsp;//the name can be anything you like
&nbsp; &nbsp;this.name = 'my first api';
&nbsp; &nbsp;this.mappings['/resources'] = expandPath('./resources');
&nbsp; &nbsp;this.mappings['/taffy'] = expandPath('./taffy');

&nbsp; &nbsp;function onApplicationStart()
&nbsp; &nbsp;{
&nbsp; &nbsp; &nbsp;&nbsp;return super.onApplicationStart();
&nbsp; &nbsp;}

&nbsp; &nbsp;function onRequestStart()
&nbsp; &nbsp;{
&nbsp; &nbsp; &nbsp;&nbsp;return super.onRequestStart();
&nbsp; &nbsp;}

}
</code></pre>I also created a sibling directory called resources which has a hello.cfc file <pre><code class="code-1 nolinks" id="code-20-43121519-2">component extends="taffy.core.resource" taffy_uri="/hello" { function get(){ return rep( [ 'hello', 'world' ] ); } 
}
</code></pre>If I try to use the API by doing: <a href="http://localhost:8888/api/hello" rel="ugc">http://localhost:8888/api/hello</a>&nbsp; I get the error that the requested resource is not available I am also not clear how to access the Taffy dashboard. If I try:&nbsp;<a href="http://localhost:8888/api/index.cfm" rel="ugc">http://localhost:8888/api/index.cfm</a>&nbsp; I get a blank screen
</div>

<div>
I rebooted my computer and now the dashboard works. My Dashboard currently looks like the following: <a href="https://filedb.experts-exchange.com/incoming/2020/07_w29/1477013/1594582212134.png" rel="ugc"> <img src="https://filedb.experts-exchange.com/incoming/2020/07_w29/1477013/1594582212134.png" class="fr-fic fr-dib"></a>How do I use my APIs? For example, if I try&nbsp;<a href="http://localhost:8888/api/hello" rel="ugc">http://localhost:8888/api/hello</a>&nbsp; I get the error that the resource is not available 
</div>

1594582212134.png

<div>
After googling other websites I found there were references that suggested I need to edit my web.xml file. I have updated the web.xml file and changed (I added the line &lt;url-pattern&gt;/api/index.cfm/*&lt;/url-pattern&gt;): &nbsp; &nbsp; &lt;servlet-mapping&gt; &nbsp; &nbsp; &nbsp; &lt;servlet-name&gt;CFMLServlet&lt;/servlet-name&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;*.cfc&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;*.cfm&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;*.cfml&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/index.cfc/*&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/index.cfm/*&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/index.cfml/*&lt;/url-pattern&gt; &nbsp; &lt;/servlet-mapping&gt; to be &nbsp; &nbsp; &lt;servlet-mapping&gt; &nbsp; &nbsp; &nbsp; &lt;servlet-name&gt;CFMLServlet&lt;/servlet-name&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;*.cfc&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;*.cfm&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;*.cfml&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/index.cfc/*&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/index.cfm/*&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/index.cfml/*&lt;/url-pattern&gt; &nbsp; &nbsp; &nbsp; &lt;url-pattern&gt;/api/index.cfm/*&lt;/url-pattern&gt; &nbsp; &lt;/servlet-mapping&gt; 
</div>

<div>
Is anyone able to help me with this
</div>

<div>
In Taffy did you mapped all the settings ? like below : &nbsp; &nbsp;this.dirPath = getDirectoryFromPath(getCurrentTemplatePath()); &nbsp; &nbsp; &nbsp; this.mappings["/resources"] = this.dirPath &amp; "resources/"; &nbsp; &nbsp; &nbsp; this.mappings["/taffy"] = this.dirPath &amp; "taffy/"; &nbsp; &nbsp; &nbsp; // this.mappings["/testbox"] = this.dirPath &amp; "testbox/"; &nbsp; &nbsp; &nbsp; // this.mappings["/bugLog"] = this.dirPath &amp; "BugLogHQ/"; &nbsp; &nbsp; &nbsp; // this.mappings["/Hoth"] = this.dirPath &amp; "Hoth/"; &nbsp; &nbsp; &nbsp; this.mappings["/di1"] = this.dirPath &amp; "di1/"; resoruces folder, taffy folder &nbsp;ur dependency injection may be di1, coldspring etc.
</div>

<div>
I have setup the Taffy using a similar directory structure as described in on: <a href="http://docs.taffy.io/3.2.0#global-taffy-mapping" rel="ugc">http://docs.taffy.io/3.2.0#global-taffy-mapping</a>&nbsp; <a href="https://filedb.experts-exchange.com/incoming/2020/08_w35/1495661/1598225607996.png" rel="ugc"><img src="https://filedb.experts-exchange.com/incoming/2020/08_w35/1495661/1598225607996.png" class="fr-fic fr-dib"></a>in my case the application.cfc and index.cfm files are in /root/api. taffy and rescources directories are in subdirectories that are siblings to application.cfc. Ie. they are: /root/api/taffy and /root/api/resources. This is what my application.cfc file currently looks like: <pre><code class="code-10 nolinks" id="code-20-43145014-1">component
extends="taffy.core.api"
{

&nbsp; &nbsp;//the name can be anything you like
&nbsp; &nbsp;this.name = 'my first api';
&nbsp; &nbsp;this.mappings['/resources'] = expandPath('./resources');
&nbsp; &nbsp;this.mappings['/taffy'] = expandPath('./taffy');

&nbsp; &nbsp;function onApplicationStart()
&nbsp; &nbsp;{
&nbsp; &nbsp; &nbsp;&nbsp;return super.onApplicationStart();
&nbsp; &nbsp;}

&nbsp; &nbsp;function onRequestStart()
&nbsp; &nbsp;{
&nbsp; &nbsp; &nbsp;&nbsp;return super.onRequestStart();
&nbsp; &nbsp;}


&nbsp; &nbsp; // this function is called after the request has been parsed and all request details are known
&nbsp; &nbsp; function onTaffyRequest(verb, cfc, requestArguments, mimeExt) {
&nbsp; &nbsp; &nbsp; &nbsp; // this would be a good place for you to check API key validity and other non-resource-specific validation
&nbsp; &nbsp; &nbsp; &nbsp; return true;
&nbsp; &nbsp; }
}
</code></pre> When I try:&nbsp;<a href="http://localhost:8888/api/hello" rel="ugc">http://localhost:8888/api/hello</a> I get the following error: <a href="https://filedb.experts-exchange.com/incoming/2020/08_w35/1495663/1598225889803.png" rel="ugc"><img src="https://filedb.experts-exchange.com/incoming/2020/08_w35/1495663/1598225889803.png" class="fr-fic fr-dib fr-fil"></a> 
</div>

1598225889803.png

1598225607996.png

<div>
I also tried the following application.cfc and had the same problem <pre><code class="code-10 nolinks" id="code-20-43145017-1">component
extends="taffy.core.api"
{

&nbsp; &nbsp;//the name can be anything you like
&nbsp; &nbsp;this.name = 'my first api';
&nbsp; &nbsp;this.dirPath = getDirectoryFromPath(getCurrentTemplatePath());
&nbsp; &nbsp;this.mappings["/resources"] = this.dirPath &amp; "resources/";
&nbsp; &nbsp;this.mappings["/taffy"] = this.dirPath &amp; "taffy/";

&nbsp; &nbsp;function onApplicationStart()
&nbsp; &nbsp;{
&nbsp; &nbsp; &nbsp;&nbsp;return super.onApplicationStart();
&nbsp; &nbsp;}

&nbsp; &nbsp;function onRequestStart()
&nbsp; &nbsp;{
&nbsp; &nbsp; &nbsp;&nbsp;return super.onRequestStart();
&nbsp; &nbsp;}


&nbsp; &nbsp; // this function is called after the request has been parsed and all request details are known
&nbsp; &nbsp; function onTaffyRequest(verb, cfc, requestArguments, mimeExt) {
&nbsp; &nbsp; &nbsp; &nbsp; // this would be a good place for you to check API key validity and other non-resource-specific validation
&nbsp; &nbsp; &nbsp; &nbsp; return true;
&nbsp; &nbsp; }
}
</code></pre>
</div>

<div>
I think I figured it out. I was calling the api incorrectly. If I use:&nbsp;<a href="http://localhost:8888/api/index.cfm/hello" rel="ugc">http://localhost:8888/api/index.cfm/hello</a>&nbsp; then it works
</div>

WestCoast_BC

<div>
<div class="content wysiwyg-content">
I am trying to learn about Rest API and I see that Coldfusion supports Rest Services. I am new to all of this. &nbsp;I have registered a rest service and it seems to work. Is this the same as REST API that I see referenced on other sites? 
 
I see a lot of sites that have an API have very similar documentation that looks something like: 
<a href="https://filedb.experts-exchange.com/incoming/2020/07_w28/1476519/api.PNG" target="_blank" title="API documentation (15 KB)"><img alt="API documentation" class="file-block lazyload" style="max-width: 800px;" data-src="https://filedb.experts-exchange.com/incoming/2020/07_w28/800_1476519/api.PNG" /></a> 
How is this created? Are there tools to do this? 
 
Thank you for any help that you can provide regarding creating REST APIs and documenting them. My website is written using Lucee (Coldfusion) and connects to a MySQL database.
</div>
</div>

api.PNG

I am trying to learn about Rest API and I see that Coldfusion supports Rest Services. I am new to all of this.  I have registered a rest service and it seems to work. Is this the same as REST API that I see referenced on other sites?

I see a lot of sites that have an API have very similar documentation that looks something like:


How is this created? Are there tools to do this?

Thank you for any help that you can provide regarding creating REST APIs and documenting them. My website is written using Lucee (Coldfusion) and connects to a MySQL database.

Coldfusion Rest API

ColdFusion is a server-side rapid application development platform originally created by Allaire and now sold by Adobe, implementing the dynamic general purpose CFML programming language. The term ColdFusion is sometimes colloquially used to refer to the CFML language (Cold Fusion Markup Language), but can also include discussions of the server software implementation. ColdFusion runs using a customised version of Apache Tomcat. Earlier versions are bundled with JRun.

ColdFusion Language

Databases are organized collections of data, most commonly accessed through management systems including schemas, tables, queries and processes that allow users to enter and manipulate the information or utilize it in other fashions, such as with web applications or for reporting purposes.

Databases

Representational state transfer (REST) is an architectural style that gives a coordinated set of constraints to the design of components in a distributed hypermedia system used to design networked applications. RESTful systems typically communicate over Hypertext Transfer Protocol (HTTP) with the same HTTP verbs (GET, POST, PUT, DELETE, etc.) that web browsers use to retrieve web pages and to send data to remote servers. REST interfaces with external systems using resources identified by Uniform Resource Identifier (URI) that can be operated upon using standard verbs.