menu
Logo
  • Why azing?
  • Blog
  • Help
ENarrow_drop_down
  • DE
  • EN
Suche in Checklisten
search
azing Logo ENarrow_drop_down
  • DE
  • EN
  • Why azing?
  • Help
2sxc
drive_folder_upload
  • homeChecklist Templates
  • south
  • fiber_manual_recordZ: Internal Stuff for the 2sxc-Dev Team
  • south

folder_sharedIntegration with Other Platforms

  • homeChecklist Templates
  • south
  • fiber_manual_recordZ: Internal Stuff for the 2sxc-Dev Team
  • south

folder_sharedIntegration with Other Platforms

Folders and checklists

  • check_circle1.1 Basic Read-Integration
  • check_circle1.2 First Web APIs
  • check_circle1.3 First JS Integration
  • check_circle2.1 WebApis - Create Stateless and Stateful ControllerBase
  • check_circle2.2 Modify Insights Controller from 1.2 to use Stateless Base Controller
  • check_circle2.3 Implement EditController Load-Action
  • check_circle2.4 Implement EditController EntityPicker
  • check_circle2.5 Implement Link Resolve
  • check_circle3.0 ADAM integration WIP

Parts (0) expand_more

These are small document-parts which are used in other documents. They are not a starting point for any real activity. Because of this, they will be listed further down and the search will not list them unless requested. 

In this step we want to get a first WebApi Controller to work.

We'll start with the Insights Controller since it's fairly simple and doesn't any UIs. 

  1. Define the path where APIs will be published. In general we need some kind of root path, after which all 2sxc endpoints are added. Common roots are /api/sxc/, [some-root]/api/sxc/ or similar.
  2. Determine where you'll store all your web-api files. In the end there will be about 30 in various folders, so let's assume you'll call it Controllers.
  3. In your location create a Sys folder. 
  4. Create a Web-API Controller in the technology that you're using - usually called InsightsController.  Define the route
  5. Now create a simple Ping-action just to see it work. If all worked, you should be calling something like /api/sys/insights/ping and getting a result. 
  6. Now continue to creating the entire insights controller. If you have a proper DI-system which initializes the controllers, use the examples from ToSic.Sxc.Oqt. If you don't, use the DNN examples. 

If you have the insights, can start with /api/sxc/insights/help and navigate around in the memory, then you have your first controller working!

Logo
Legal | Content Copyright CC-BY 4.0
bug_reportReport Bug
  • info
  • Links
  • Permissions
code Share
code
URL copied to clipboard.
Embed Checklist close
Copy Copy
Content Copyright

CC-BY 4.0

Translations

None

2sxc - Content Management for DNN & Oqtane Logo

2sxc - Content Management for DNN & Oqtane

QR-Code
azing.org/2sxc/r/4UiVMtnJ
View & Use

Public (can be used by everybody)

Edit & Admin

Default (all members can edit)

This catalog has a simple permission model, where all members have the same permissions. For advanced permissions, upgrade to Enterprise.

Here you can see how this document is used and linked by other documents

Used in (1)

Others referencing this

  1. 2.2 Modify Insights Controller from 1.2 to use Stateless Base Controller
Uses these (0)

Documents linked from this document

How it Behaves

How this document is categorized changes how it behaves.

This is a main document, it is listed normally and appears in search result.

Type

This is a Checklist. Lists are converted into checkboxes.

Get something to say?

Comment to start a discussion or make a note
send

please log on to chat

close

Durchsuche ganz Azing