Domů
Nápověda
Přihlásit
Registrovat
Vítejte
Host
. Prosím
přihlašte se
nebo
zaregistrujte
.
Forum Delphi.cz
»
Delphi
»
Obecné
»
Delphi MVCFramework + Swagger dokumentace parametrů ?
« předchozí
další »
Tisk
Stran: [
1
]
Dolů
Autor
Téma: Delphi MVCFramework + Swagger dokumentace parametrů ? (Přečteno 801 krát)
Duhacek
Nováček
Příspěvků: 19
Karma: 0
Delphi MVCFramework + Swagger dokumentace parametrů ?
«
kdy:
08-02-2023, 14:11:57 »
Zdravím delphisty,
prosím kdo používáte DMVCF + dokumentaci Swagger – dá se do ní nějak přidat "volitelný" parametr z URL cesty (viz obr) ?
Tedy aby v přehledu endpointu /zamestnanec byl nejen parametr "idzamestnance" ale i "cislo" ?
Díky.
IP zaznamenána
Radek Červinka
Administrátoři
Padawan
Příspěvků: 3532
Karma: 112
Verze Delphi: D2007, DXE + 2 poslední
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #1 kdy:
08-02-2023, 14:17:40 »
Excellent
Rated
1
time
[MVCSwagParam(plPath, 'Id', 'user id', ptInteger, True, '1')]
plPath je to co potrebujes
IP zaznamenána
Embarcadero MVP - Czech republic
Radek Červinka
Administrátoři
Padawan
Příspěvků: 3532
Karma: 112
Verze Delphi: D2007, DXE + 2 poslední
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #2 kdy:
08-02-2023, 14:18:20 »
Excellent
Rated
1
time
resp cele
Kód: Delphi
[Vybrat]
[
MVCPath
(
'/UserRight/($Id)'
)
]
[
MVCHTTPMethod
(
[
httpGET
]
)
]
{$IFNDEF DEBUG} [MVCRequiresRole('role1')] {$ENDIF}
[
MVCSwagSummary
(
'User'
,
'List all UserRights by User'
,
'GetUserRight'
)
]
[
MVCSwagParam
(
plPath
,
'Id'
,
'user id'
,
ptInteger
,
True
,
'1'
)
]
[
MVCSwagResponses
(
200
,
'Success'
,
TUserRight
,
True
)
]
[
MVCSwagResponses
(
500
,
'Internal Server Error'
)
]
procedure
GetUserRight
(
const
Id
:
Integer
)
;
IP zaznamenána
Embarcadero MVP - Czech republic
Duhacek
Nováček
Příspěvků: 19
Karma: 0
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #3 kdy:
08-02-2023, 21:02:38 »
Citace: Radek Červinka 08-02-2023, 14:17:40
plPath je to co potrebujes
Tak bohužel, když u parametru "cislo" změním plQuery na plPath, ve swagger docu se to neukáže.
Potřeboval bych tam něco ve stylu viz obr.
IP zaznamenána
Radek Červinka
Administrátoři
Padawan
Příspěvků: 3532
Karma: 112
Verze Delphi: D2007, DXE + 2 poslední
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #4 kdy:
08-02-2023, 23:29:30 »
Excellent
Rated
1
time
Tak jeste jednou, viz. priloha
Kód: Delphi
[Vybrat]
[
MVCPath
(
'/UserRight/($Id)'
)
]
[
MVCHTTPMethod
(
[
httpGET
]
)
]
{$IFNDEF DEBUG} [MVCRequiresRole('roleextra')] {$ENDIF}
[
MVCSwagSummary
(
'User'
,
'List all UserRights by User'
,
'GetUserRight'
)
]
[
MVCSwagParam
(
plPath
,
'Id'
,
'user id'
,
ptInteger
,
True
,
'1'
)
]
[
MVCSwagParam
(
plQuery
,
'data'
,
'extra data id'
,
ptInteger
,
True
,
'1'
)
]
[
MVCSwagResponses
(
200
,
'Success'
,
TUserRight
,
True
)
]
[
MVCSwagResponses
(
500
,
'Internal Server Error'
)
]
procedure
GetUserRight
(
const
Id
:
Integer
)
;
IP zaznamenána
Embarcadero MVP - Czech republic
Duhacek
Nováček
Příspěvků: 19
Karma: 0
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #5 kdy:
09-02-2023, 06:54:02 »
Citace: Radek Červinka 08-02-2023, 23:29:30
Tak jeste jednou, viz. priloha
Díky moc, mám to zřejmě nějaké "nabourané", protože u sebe nevidím ani ten text ze MVCSwagSummary, který u tebe zobrazen je...
IP zaznamenána
Radek Červinka
Administrátoři
Padawan
Příspěvků: 3532
Karma: 112
Verze Delphi: D2007, DXE + 2 poslední
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #6 kdy:
09-02-2023, 07:42:47 »
Excellent
Rated
1
time
Mas v uses MVCFramework.Swagger.Commons ?
Delphi jako chybejici atribut nehlasi jako chybu pri kompilaci, jen proste v RTTI neni. Jinam mam DMVC asi pul roku stare, ale to se asi nezmenilo.
Podivej se do examplu, tam to bylo.
IP zaznamenána
Embarcadero MVP - Czech republic
Duhacek
Nováček
Příspěvků: 19
Karma: 0
Re:Delphi MVCFramework + Swagger dokumentace parametrů ?
«
Odpověď #7 kdy:
09-02-2023, 08:02:52 »
Super 👍
Už je to OK, měl jsem sice MVCFramework.Swagger.Commons v hlavním dpr, ale po přidání i do té unity kontroleru to začalo fungovat.
IP zaznamenána
Radek Červinka
Administrátoři
Padawan
Příspěvků: 3532
Karma: 112
Verze Delphi: D2007, DXE + 2 poslední
Re:Delphi MVCFramework Swagger dokumentace parametrů ?
«
Odpověď #8 kdy:
09-02-2023, 08:06:53 »
Excellent
Rated
1
time
Jinak samozrejme to vyhodi warning
[dcc32 Warning] uControlerxx.pas(119): W1074 Unknown custom attribute
IP zaznamenána
Embarcadero MVP - Czech republic
Tisk
Stran: [
1
]
Nahoru
« předchozí
další »
Forum Delphi.cz
»
Delphi
»
Obecné
»
Delphi MVCFramework + Swagger dokumentace parametrů ?