Update endpoint names and readme.

Author: techyian

assets/reportviewer.net.js

@@ -1,9 +1,11 @@
-function ReportViewer() {
+function ReportViewer(apiPath, rdlName) {
 
     var self = this;
 
     self.toggleItemRequests = [];
     self.metadata = [];
+    self.apiPath = apiPath;
+    self.rdlName = rdlName;
 
     function constructReportParameters() {
         var eles = $('.report-viewer input');
@@ -71,7 +73,7 @@
 
         return $.ajax({
             method: 'POST',
-            url: `/Home/ParameterViewer`,
+            url: `${self.apiPath.replace(/\/$/, "")}/GenerateParameters?rdl=${self.rdlName}`,
             data: JSON.stringify(dto),
             contentType: 'application/json; charset=utf-8'
         }).done(function (data, textStatus, jqXHR) {
@@ -126,7 +128,7 @@
 
         return $.ajax({
             method: 'POST',
-            url: `/Home/ReportViewer`,
+            url: `${self.apiPath.replace(/\/$/, "")}/GenerateReport?rdl=${self.rdlName}`,
             data: JSON.stringify(dto),
             contentType: 'application/json; charset=utf-8'
         }).done(function (data, textStatus, jqXHR) {

readme.md

@@ -12,7 +12,24 @@ ReportViewer.NET is currently designed to target .NET 8.
 
 1. Include the provided CSS in `assets/reportviewer.net.css` in your project.
 2. Include the provided JS in `assets/reportviewer.net.js` in your project.
-3. Read the remainder of this section to learn how to use ReportViewer.NET in your project.
+3. Create the HTML placeholder element and load the JS in your HTML file by adding the following: 
+
+```
+<div class="report-viewer">
+
+</div>
+
+<script type="text/javascript">
+    var reportViewer = new ReportViewer('/api/Reports', 'My RDL file');
+
+    reportViewer.postReportParameters();    
+</script>
+
+```
+
+The `ReportViewer` function accepts two parameters: `apiPath` and `rdlName`, where `apiPath` references the name of your API path minus the endpoint itself. ReportViewer.NET expects two endpoints to be available on the given path: `GenerateParameters` and `GenerateReport`.
+
+4. Read the remainder of this section to learn how to use ReportViewer.NET in your project.
 
 ReportViewer.NET exposes the Interface `IReportHandler` and Class `ReportHandler` which are intended to be injected to your ASP.NET Controller via Dependency Injection. Please ensure that you register ReportViewer.NET using a Scoped/Transient lifetime - this library should not be registered with a Singleton lifetime.
 
@@ -60,7 +77,7 @@ public class HomeController : Controller, IReportViewerController
     // Default endpoints omitted for brevity.
     
     [HttpPost]
-    public async Task<IActionResult> ParameterViewer([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
+    public async Task<IActionResult> GenerateParameters([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
     {
         // The 'LoadReport' method parses the report RDL's XML and initialises the C# object hierarchy.
         _reportViewer.LoadReport(rdl, userProvidedParameters);
@@ -72,7 +89,7 @@ public class HomeController : Controller, IReportViewerController
     }
     
     [HttpPost]
-    public async Task<IActionResult> ReportViewer([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
+    public async Task<IActionResult> GenerateReport([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
     {   
         // The 'LoadReport' method parses the report RDL's XML and initialises the C# object hierarchy.
         _reportViewer.LoadReport(rdl, userProvidedParameters);

src/ReportViewer.NET.Web/Controllers/HomeController.cs

@@ -32,17 +32,17 @@ public IActionResult Error()
         }
 
         [HttpPost]
-        public async Task<IActionResult> ParameterViewer([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
-        {
+        public async Task<IActionResult> GenerateParameters([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
+        {            
             _reportViewer.LoadReport(rdl, userProvidedParameters);
             var paramHtml = await _reportViewer.PublishReportParameters(rdl, userProvidedParameters.Parameters);
 
             return Ok(paramHtml);
         }
 
         [HttpPost]
-        public async Task<IActionResult> ReportViewer([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
-        {            
+        public async Task<IActionResult> GenerateReport([FromQuery] string rdl, [FromBody] ReportParameters userProvidedParameters)
+        {         
             _reportViewer.LoadReport(rdl, userProvidedParameters);
             var reportHtml = await _reportViewer.PublishReportOutput(rdl, userProvidedParameters);
 

src/ReportViewer.NET.Web/Views/Home/Index.cshtml

@@ -14,7 +14,7 @@
 
 @section Scripts {
     <script type="text/javascript">
-        var reportViewer = new ReportViewer();
+        var reportViewer = new ReportViewer('/Home/','My RDL file');
 
         reportViewer.postReportParameters();    
     </script>

src/ReportViewer.NET.Web/wwwroot/js/site.js

@@ -1,9 +1,11 @@
-function ReportViewer() {
+function ReportViewer(apiPath, rdlName) {
 
     var self = this;
 
     self.toggleItemRequests = [];
     self.metadata = [];
+    self.apiPath = apiPath;
+    self.rdlName = rdlName;
 
     function constructReportParameters() {
         var eles = $('.report-viewer input');
@@ -71,7 +73,7 @@
 
         return $.ajax({
             method: 'POST',
-            url: `/Home/ParameterViewer`,
+            url: `${self.apiPath.replace(/\/$/, "")}/GenerateParameters?rdl=${self.rdlName}`,
             data: JSON.stringify(dto),
             contentType: 'application/json; charset=utf-8'
         }).done(function (data, textStatus, jqXHR) {
@@ -126,7 +128,7 @@
 
         return $.ajax({
             method: 'POST',
-            url: `/Home/ReportViewer`,
+            url: `${self.apiPath.replace(/\/$/, "")}/GenerateReport?rdl=${self.rdlName}`,
             data: JSON.stringify(dto),
             contentType: 'application/json; charset=utf-8'
         }).done(function (data, textStatus, jqXHR) {

src/ReportViewer.NET/IReportViewerController.cs

@@ -6,7 +6,7 @@ namespace ReportViewer.NET
 {
     public interface IReportViewerController
     {
-        Task<IActionResult> ParameterViewer(string rdl, ReportParameters userProvidedParameters);        
-        Task<IActionResult> ReportViewer(string rdl, ReportParameters userProvidedParameters);
+        Task<IActionResult> GenerateParameters(string rdl, ReportParameters userProvidedParameters);        
+        Task<IActionResult> GenerateReport(string rdl, ReportParameters userProvidedParameters);
     }
 }