/ doc / DocFrag / ARCAPI.BaseController / Attribute / Description

Description

Edit keys at this level only

= Contains basic functionality for serving API methods.0x000D0x000A0x000D0x000AThe specific controller instances serving requests are usually stored in a global -DataStorage- like 'as/0x007BnodeId0x007D/Controller/0x007BTypeOfController0x007D/0x007BControllerId0x007D...'.0x000D0x000A(in other words, -ControllerStorage- actually points to a branch inside -Storage-.)0x000D0x000A0x000D0x000AExamples of API requests and how they are resolved to a container by -CatchAll-:0x000D0x000AAPI request URL: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000AController instance (in this case of type -RQController-) to be found in controllerStorage0x005B"RQController"0x005D0x000D0x000AMethod -APIMethod- is called on this instance.0x000D0x000A0x000D0x000AThe following controller classes are included within -ARCAPI-:0x000D0x000A0x000D0x000A-RQController-:0x000D0x000AExecutes a REST like query request against the given -DataStorage-.0x000D0x000AExample: https://yourserver.com/RQ/dt/Customer/42 0x000D0x000A0x000D0x000A-AddController-:0x000D0x000AParses and stores a -PropertyStreamLine-.0x000D0x000AExample: https://yourserver.com/Add/dt/Customer/42/FirstName = John0x000D0x000A0x000D0x000A-GQController-:0x000D0x000AOffers GraphQL queries.0x000D0x000ANot implemented as of Dec 2020.0x000D0x000A0x000D0x000A-EditController-:0x000D0x000AOffers a simple HTML editing environment of the raw -PropertyStream- from the given key.0x000D0x000AExample: https://yourserver.com/Edit/dt/Customer/420x000D0x000A0x000D0x000ANote how these controllers are sufficient for a basic CRUD API (Create, Read, Update, Delete).0x000D0x000A(Delete is done by using the metakey -Invalid-.)0x000D0x000A0x000D0x000AOften no additional -ApplicationSpecificCode- is needed.0x000D0x000A0x000D0x000ASee -BuildControllerStorage- for how -ApplicationSpecificCode- controllers are integrated.0x000D0x000A0x000D0x000AThis system has the following advantages:0x000D0x000A0x000D0x000A1) The API-routing syntax is by default exposed to the outside because the -ControllerStorage- is normally inserted into the global -DataStorage-.0x000D0x000ATherefore the standard query mechanism in AgoRapide can be used to get this information by querying like0x000D0x000A'RQ/log/0x005BnodeId0x005D/Controller'0x000D0x000A0x000D0x000A2) The API itself is discoverable even without querying like above, without much special code.0x000D0x000AThis is because an invalid API request is actually analyzed by the same mechanism answering standard queries.0x000D0x000AWhen the error message is returned it actually contains data about the correct syntax.0x000D0x000A0x000D0x000A3) The API is configurable both through the API itself and also over the -PropertyStream-.0x000D0x000AFor instance like 'Add/log/0x005BnodeId0x005D/Controller/RQ/~std/LogLevel = Warning' which would change the log level for the standard instance ('std') of -RQController- to 'Warning'.0x000D0x000A0x000D0x000A4) Different instances of the same controller type can exist and be configured individually.0x000D0x000AFor instance if some specific query needs additional logging down to debug level, a dedicated controller can be created for this and configured individually, like0x000D0x000A'Add/log/0x005BnodeId0x005D/Controller/RQController/~dbg/LogLevel = Debug'0x000D0x000A(Note: Such a debug controller is created by default by -BuildControllerStorage-).0x000D0x000A0x000D0x000ANOTE: Such specific controller instances can be used like 'RQ~dbg/...' instead of 'RQ/~dbg/...'. NOTE: This make inserted links more correct, for instance when -RQController- links to -EditController-0x000D0x000ANOTE: The reason for the somewhat special ~ prefix for the controller instance key is to avoid ambiguities NOTE: which are inherent because the complete hierarchical level has not been deemed necessary to specify explicitly.0x000D0x000A0x000D0x000A0x000D0x000ASome limitations of this approach are:0x000D0x000A1) Actual API method name is limited to the name of the controller type (without the 'Controller' part).0x000D0x000AThat is, a controller called CustomerController can only serve queries starting with 'Customer'.0x000D0x000A0x000D0x000ANote however that in your -ApplicationSpecificCode- you can implement any additional controllers with routing structure totally independent of this standard generic AgoRapide mechanism.0x000D0x000AIn other words, you can keep the AgoRapide mechanism for its standardised approach to data manipulation and add additional traditional controllers and methods as needed.0x000D0x000A0x000D0x000ANote how the -BaseController- classes (like this class) do not inherit any special Microsoft.AspNetCore.Mvc class. They are totally stand-alone with regard to Microsoft.AspNetCore.Mvc.0x000D0x000A0x000D0x000A

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

Generated 2025-11-01 16:50:54.197 UTC