Swagger @ApiParam לעומת @ApiModelProperty
רק הכרזתי על החדש למד אביב קורס, המתמקד ביסודות האביב 5 ומגף האביב 2:
>> בדוק את הקורס1. סקירה כללית
במדריך זה נבחן בקצרה את סוואגר @ApiParam ו @ApiModelProperty ביאורים. יתר על כן, נשווה ביאורים אלה ונזהה את השימוש הנכון עבור כל אחת מהן.
2. הבדל מפתח
פשוט שים, @ApiParam ו @ApiModelProperty ביאורים מוסיפים מטא נתונים שונים לסוואגר. ה @ApiParam ההערה היא עבור הפרמטרים של בקשת משאבים API, ואילו @ApiModelProperty מיועד למאפייני המודל.
3. @ApiParam
ה @ApiParam ההערה נועדה לשימוש אך ורק עם הערות פרמטר JAX-RS 1.x / 2.x כמו @ PathParam, @QueryParam, @HeaderParam, @FormParam, ו @BeanParam. למרות ש סוואגר ליבה סורק את ההערות האלה כברירת מחדל, נוכל להשתמש בהן @ApiParam כדי להוסיף פרטים נוספים על הפרמטרים או לשנות את הערכים בזמן קריאתם מהקוד.
ה @ApiParam ביאור מסייע לציין את השם, הסוג, התיאור (ערך) וערך הדוגמה של הפרמטר. יתר על כן, אנו יכולים לציין אם הפרמטר נדרש או אופציונלי.
בואו נסתכל על השימוש בו:
@RequestMapping (method = RequestMethod.POST, value = "/ createUser", מייצר = "application / json; charset = UTF-8") @ResponseStatus (HttpStatus.CREATED) @ResponseBody @ApiOperation (value = "צור משתמש", הערות = "שיטה זו יוצרת משתמש חדש") משתמש ציבורי createUser (@ApiParam (name = "firstName", type = "String", value = "שם פרטי המשתמש", לדוגמא = "Vatsal", חובה = true) @ RequestParam String firstName) {משתמש משתמש = משתמש חדש (שם פרטי); משתמש חוזר; }בואו נסתכל על ייצוג ממשק המשתמש של Swagger עבורנו @ApiParam דוגמא:
עכשיו, בואו נסתכל על @ApiModelProperty.
4. @ApiModelProperty
ה @ApiModelProperty ביאור מאפשר לנו לשלוט בהגדרות ספציפיות לסוואגר כגון תיאור (ערך), שם, סוג נתונים, ערכי דוגמה וערכים מותרים למאפייני המודל.
כמו כן, הוא מציע מאפייני סינון נוספים למקרה שנרצה להסתיר את הנכס בתרחישים מסוימים.
בואו נוסיף כמה מאפייני מודל ל- של המשתמששם פרטי שדה:
@ApiModelProperty (value = "שם פרטי המשתמש", name = "firstName", dataType = "String", example = "Vatsal") First string מחרוזת;עכשיו, בואו נסתכל על ה- מִשׁתַמֵשׁ מפרטי הדגם בממשק המשתמש של Swagger:
5. מסקנה
במאמר מהיר זה, בחנו שתי הערות Swagger בהן אנו יכולים להשתמש כדי להוסיף מטא נתונים עבור פרמטרים ומאפייני מודל. לאחר מכן, הסתכלנו על קוד לדוגמא באמצעות הערות אלה וראינו את ייצוגיהם בממשק המשתמש של Swagger.
כמו תמיד, כל דוגמאות הקוד הללו זמינות ב- GitHub.
תחתית Java
