Xeku.FullTextSearch.WebApi
0.0.0.7
dotnet add package Xeku.FullTextSearch.WebApi --version 0.0.0.7
NuGet\Install-Package Xeku.FullTextSearch.WebApi -Version 0.0.0.7
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Xeku.FullTextSearch.WebApi" Version="0.0.0.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Xeku.FullTextSearch.WebApi" Version="0.0.0.7" />
<PackageReference Include="Xeku.FullTextSearch.WebApi" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Xeku.FullTextSearch.WebApi --version 0.0.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Xeku.FullTextSearch.WebApi, 0.0.0.7"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Xeku.FullTextSearch.WebApi@0.0.0.7
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Xeku.FullTextSearch.WebApi&version=0.0.0.7
#tool nuget:?package=Xeku.FullTextSearch.WebApi&version=0.0.0.7
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Xeku.FullTextSearch.WebApi
Web API extension for the FullTextSearch module. Provides RESTful API endpoints for global full-text search across all business objects.
Features
- RESTful API: Standard Web API endpoint for global search
- Configurable Limits: Control maximum results per request
- Secure by Default: Requires authentication via
[Authorize] - Rich Response: Returns display name, object key, type info, and matched content
Installation
- NuGet Package:
dotnet add package Xeku.FullTextSearch.WebApi
- Register the module in your application:
RequiredModuleTypes.Add(typeof(Xeku.FullTextSearch.WebApi.FullTextSearchWebApiModule));
API Reference
Search Endpoint
GET /api/GlobalSearch?keyword={keyword}&maxResults={maxResults}&maxPerType={maxPerType}
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
keyword |
string | Yes | - | Search keyword |
maxResults |
int | No | 200 | Maximum total results |
maxPerType |
int | No | 50 | Maximum results per type |
Response Example
{
"keyword": "john",
"totalCount": 3,
"results": [
{
"displayName": "John Doe",
"objectKey": "abc123-def456",
"typeCaption": "Customer",
"typeFullName": "Sample.Module.BusinessObjects.Customer",
"matchedContent": "Name: John Doe | Email: john@example.com"
}
]
}
Response Codes
| Code | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request (missing keyword) |
| 401 | Unauthorized |
Usage Examples
cURL
curl -X GET "https://localhost:5001/api/GlobalSearch?keyword=test" \
-H "Authorization: Bearer YOUR_TOKEN"
JavaScript (Fetch)
const response = await fetch('/api/GlobalSearch?keyword=test', {
headers: { 'Authorization': 'Bearer ' + token }
});
const data = await response.json();
console.log(data.results);
Architecture
| File | Description |
|---|---|
FullTextSearchWebApiModule.cs |
XAF module definition |
GlobalSearchController.cs |
API controller |
GlobalSearchDTOs.cs |
Data transfer objects |
Requirements
- DevExpress XAF 22.2+
- .NET 8.0+
- Xeku.FullTextSearch module
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- DevExpress.ExpressApp.WebApi (>= 25.2.3)
- Xeku.FullTextSearch (>= 0.0.0.7)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.