Skapa anpassade REST API-slutpunkter i Dotnetnuke (DNN)
Översikt
DNN REST API-plugin gör det möjligt att skapa anpassade API-slutpunkter inom DNN-plattformen, vilket gör att externa system kan interagera med DNN-funktioner. Du kan enkelt konfigurera dina anpassade API-slutpunkter för att uppfylla specifika krav, med alla HTTP-metoder. Den här användarhandboken erbjuder omfattande dokumentation som hjälper dig att ställa in och testa anpassade API:er.
Förutsättningar: Ladda ner och installation
- För att konfigurera anpassade API:er för DNN REST API måste du installera miniOrange DNN REST API Authentication plugin från DNN-butiken.
- Ladda upp installationspaketet genom att gå till Inställningar > Tillägg > Installera tillägg.
Konfigurationssteg
Steg-för-steg-guide för DNN Custom API-autentisering.
1. Lägg till modul på DNN-sidan
- Öppna någon av sidorna på din DNN-webbplats (redigeringsläge) och klicka på Lägg till modul.
- Sök efter DNN REST API och klicka på DNN REST API. Dra och släpp modulen på sidan där du vill.
- Du har slutfört installationen av DNN REST API-modulen på din DNN-webbplats.
2. Skapa anpassade API:er
- Navigera till Fliken DNN REST API Inställningar. Här kommer du att se DNN REST API Authentication-plugin-instrumentpanel.
- Klicka på Skapa API, för att initiera anpassad API-generering.
- Välj typ av API som Anpassat API.
- Ange följande uppgifter:
- API-namn: Ange ett unikt namn för ditt API.
- API-metod: Välja HTTP-förfrågningsmetod från rullgardinsmenyn.
- Tabellnamn: Ange den tabell du vill komma åt.
- Svarskolumn: Välj kolumner som du vill utföra operationer på.
- Konfigurera autentisering (valfritt): På fliken Avancerade inställningar kan du hitta ett alternativ för att välja autentiseringsmetoder för API som inkluderar API Key, Basic authentication, JWT etc, kartlägga autentiseringsappen som skapats för respektive metod.
- Använd filter (valfritt): Du kan tillämpa villkor på kolumnerna som gör att du kan komma åt specifika poster baserat på de använda filtren.
För att konfigurera den kan du välja kolumnen från rullgardinsmenyn Condition-kolumn och sedan välja villkoret och URL-parametern som du vill tillämpa villkoret på.
- Klicka på Generera API.
- Nu under Anpassade API:er kan du hitta ditt skapade API.
3. Testa de genererade API:erna
- För att testa API:t, klicka på Testa alternativet under Handling falla ner.
- En testpopup kommer att visas som innehåller din API-slutpunkt med den konfigurerade HTTP-metoden. Du kan hitta alternativet att skicka parametrarna i rubrikerna, eller att skicka data i brödtexten om det behövs. Klicka sedan på Kör.
- Om allt är korrekt konfigurerat kommer du att se ett lyckat svar som bekräftar att ditt API fungerar som förväntat.
- Du kan hänvisa till exempelbegäran och svarsformat för din API-begäran från testpopup-fönstret.
Den här guiden hjälper dig att konfigurera och skapa anpassade REST API:er för din DNN-webbplats. Genom att använda DNN REST API-plugin kan du säkert konfigurera, testa och hantera DNN REST API:er.
