Skip to content

API Filter

Jump to bottom
onemoon edited this page Nov 13, 2018 · 2 revisions

About Filter API

! 주의

반드시 filterType이 먼저 생성되어야 합니다. 필터를 생성하기 전 해당 filter의 타입이 먼저 생성되어있는지 확인하세요

  1. GET /filter/type 확인
    • 원하는 필터의 타입이 없다면 생성
    • 있다면 POST /filter

Total API

  • /filter
    • get
      • 모든 필터 확인
    • post
      • 새로운 필터의 생성
      • 위의 주의 참고
    • patch/image
      • image 변경 혹은 추가
      • swagger에서 이미지를 추가해주시면 됩니다.
    • patch/info
      • image를 제외한 나머지 변경
    • delete
      • 필터 삭제
  • /filter/type
    • get
      • 모든 필터 타입 확인
    • post
      • 필터 타입 생성
    • patch
      • 필터 타입 변경
      • 변경전에 있는 필터가 있는지 확인해주세요
    • delete
      • 필터 타입 삭제
      • 삭제전에 있는 필터가 있는지 확인해주세요

Basic Form

swagger를 통해서 dto 확인이 가능합니다.

[ 
// Single Outer Form
{
type : "human" ,

[
// Single Inner Form
{
name : "name" ,
standard : "one" , 
imageURL : "aws_s3_image.png" , 
align-left : 1 (boolean) ,
gravity : "bottom-center"
} , 
// Single Inner Form End
{ ... } , 
{ ... }     
]

} , 
// Single Outer Form End
{
type : "background" ,
[ {} , {} , ...] 
} ,
{ ... } , 
{ ... }     

]

Clone this wiki locally